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

aidantracy commented 2 weeks ago

References user story #1

TODO:

[x] :question: Answer question Task6_Q1 on Canvas
[x] :bust_in_silhouette: Assign yourself to this task (this will prompt the WorkflowLearning GitHub App to create the task_6_squash_preferred_project_workflow 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_6_squash_preferred_project_workflow 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_6_squash_preferred_project_workflow
[x] Edit the description of the PR to reference this task
[x] :brain: Understand the commits and file changes made in the PR
:thumbsup: Notice that the commits in the branch DO NOT reference this task #6. This is intentional, as to not clutter this task with references of commits containing partial (and incomplete) implementations (that do not contain the entire change in one commit), and which can be altered in subsequent commits in the same branch
[ ] :question: Answer question Task6_Q2 on Canvas
[ ] :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
[ ] :question: Answer question Task6_Q3 on Canvas

Starting integration...

[ ] In the PR, integrate the changes into master
using the Squash and merge option
with the squashed commit message Closes #6 (#<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.

[ ] :eyes: Inspect the history of all the branches and commits via Insights -> Network
[ ] :x: In the PR, use the GitHub interface to delete the branch (since the branch content was successfully integrated into master)
[ ] :eyes: Inspect the history of all the branches and commits via Insights -> Network
:tada: :smile: FUN FACT: the branch task_6_squash_preferred_project_workflow was deleted (more accurately hidden) from the repository, because GitHub keeps all deleted branches indefinitely, which means the commits in the branch (and the PR) can always be accessed
[ ] :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
[ ] :question: Answer question Task6_Q4 on Canvas
[ ] :question: Answer question Task6_Q5 on Canvas

:thumbsup: Advantages of this "preferred workflow" (which will be used throughout the remaining sprints of the group project)

Any developer inspecting the squashed commit in master can directly navigate

to task #6, which will be referenced by only one "atomic" commit containing the final implementation of the task, and this commit can be easily deployed or cherry-picked to other branches if needed, or
to the PR (to see all the intermediate commits for the implementation)

:bulb: Again, it is important to highlight that the intermediate (and incomplete) commits in the branch task_6_squash_preferred_project_workflow DO NOT reference this task #6 at all, and hence, they do not clutter this task with unnecessary (and confusing) references of partial (and incomplete) commits. Moreover, developers can contribute to the branch without constantly worrying about adding traceability for every intermediate commit, since they only need to establish the traceability to the task and PR once, during the integration.

workflowlearning[bot] commented 2 weeks ago

:runner: Creating branch `task_6_squash_preferred_project_workflow`...

: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_6_squash_preferred_project_workflow 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_6_squash_preferred_project_workflow` Repository full name = `aidantracy/CS471WorkflowsHomeworkAssignment` Issue number = `#6` Issue title = 'Squash with Traceability to Task and PR in Commit Message Integration Strategy, without Any Commits in the Branch Referencing the Task' Assignee login = 'aidantracy' ---

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.2` (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 = 478 ```

workflowlearning[bot] commented 2 weeks ago

:thumbsup: Branch `task_6_squash_preferred_project_workflow` 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.2` (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 = 478 ```

aidantracy / CS471WorkflowsHomeworkAssignment