Squash with Traceability to Task and PR in Commit Message Integration Strategy, but with Some Commits in the Branch Referencing the Task

abelalmeida commented 1 year ago

References user story #1

TODO:

[x] :question: Answer question Task5_Q1 on Canvas
[x] :bust_in_silhouette: Assign yourself to this task (this will prompt the WorkflowLearning GitHub App to create the task_5_squash_with_link_to_task branch)
[x] :hourglass_flowing_sand: Wait (at most) 60 seconds until the WorkflowLearning GitHub App will comment on this task and confirm that the branch task_5_squash_with_link_to_task was created (refresh the page if you don't see the confirmation comment)
[x] Create a new PR having the base branch master and the compare branch task_5_squash_with_link_to_task
[x] Edit the description of the PR to reference this task
[x] :brain: Understand the commits and file changes made in the PR
[x] :question: Answer question Task5_Q2 on Canvas
[x] :arrows_counterclockwise: Refresh this page (to ensure that any commits referencing this task are shown on this page) and scroll all the way to the bottom of the page
[x] :question: Answer question Task5_Q3 on Canvas

Starting integration...

[x] In the PR, integrate the changes into master
using the Squash and merge option
with the squashed commit message Closes #5 (#<ID_PR>) and
with an empty squashed commit extended description (i.e., delete the entire squashed commit extended description, which lists the individual commits that are in the pull request)

Integration completed.

[x] :eyes: Inspect the history of all the branches and commits via Insights -> Network
[x] :x: In the PR, use the GitHub interface to delete the branch (since the branch content was successfully integrated into master)
[x] :eyes: Inspect the history of all the branches and commits via Insights -> Network
[x] :arrows_counterclockwise: Refresh this page (to ensure that any commits referencing this task are shown on this page) and scroll all the way to the bottom of the page
[x] :question: Answer question Task5_Q4 on Canvas
[x] :question: Answer question Task5_Q5 on Canvas

:thumbsup: Advantages of this workflow

Any developer inspecting the squashed ("atomic") commit in master can directly navigate

to task #5 or
to the PR (to see all the intermediate commits for the implementation)

:heavy_exclamation_mark: Disadvantages of this workflow

If the branch contains multiple commits (each containing a partial/incomplete implementation of the task) that are referencing task #5 (like it was the case with branch task_5_squash_with_link_to_task), then these commits will automatically appear in task #5 as being referenced, and this unnecessarily clutters task #5 and confuses any developer trying to understand the changes performed in task #5.

workflowlearning[bot] commented 1 year ago

:runner: Creating branch `task_5_squash_with_link_to_task`...

:hourglass_flowing_sand: Please wait (at most) 60 seconds until the WorkflowLearning GitHub App will add a new comment to this task and confirm that the branch task_5_squash_with_link_to_task was created successfully (refresh the page if you don't see the confirmation comment).

Additional details

Detected event = `assigned` Branch to be created (containing a few commits) = `task_5_squash_with_link_to_task` Repository full name = `abelalmeida/CS471WorkflowsHomeworkAssignment` Issue number = `#5` Issue title = 'Squash with Traceability to Task and PR in Commit Message Integration Strategy, but with Some Commits in the Branch Referencing the Task' Assignee login = 'abelalmeida' ---

FAQ

**Q: What type of events trigger the [WorkflowLearning GitHub App](https://github.com/apps/workflowlearning) to create a new branch containing a series of commits?** - a developer is assigned to issues `#2`, `#3`, `#4`, `#5` and `#6` in a repository called `CS471WorkflowsHomeworkAssignment`

Beta Disclaimer

[WorkflowLearning GitHub App](https://github.com/apps/workflowlearning) `v1.0.0` (see [Semantic Versioning](https://semver.org/)) is an experimental [GitHub Application](https://developer.github.com/apps/) that attempts to provide a "sandbox" environment for learning about different **workflow integrations**, such as merge, rebase and squash. This bot is still in **BETA**, and if you think the feedback provided is inaccurate please submit a bug report (i.e., email the instructor) and you can get extra credit.

#### Debug Information ``` github_event = issues payload_action = assigned request_number = 1074 ```

workflowlearning[bot] commented 1 year ago

:thumbsup: Branch `task_5_squash_with_link_to_task` was created successfully

Please continue with the next steps as specified in the task description.

Additional details

---

FAQ

**Q: What type of events trigger the [WorkflowLearning GitHub App](https://github.com/apps/workflowlearning) to create a new branch containing a series of commits?** - a developer is assigned to issues `#2`, `#3`, `#4`, `#5` and `#6` in a repository called `CS471WorkflowsHomeworkAssignment`

Beta Disclaimer

[WorkflowLearning GitHub App](https://github.com/apps/workflowlearning) `v1.0.0` (see [Semantic Versioning](https://semver.org/)) is an experimental [GitHub Application](https://developer.github.com/apps/) that attempts to provide a "sandbox" environment for learning about different **workflow integrations**, such as merge, rebase and squash. This bot is still in **BETA**, and if you think the feedback provided is inaccurate please submit a bug report (i.e., email the instructor) and you can get extra credit.

#### Debug Information ``` github_event = issues payload_action = assigned request_number = 1074 ```

abelalmeida / CS471WorkflowsHomeworkAssignment