kubernetes
/
community
mirror of https://github.com/kubernetes/community.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #6667 from fsmunoz/prow-and-tide-squashing 

Add tide/merge-method-squash option for automated squashing
This commit is contained in:
Kubernetes Prow Robot 2023-01-02 07:31:31 -08:00 committed by GitHub
parent 8d1abadf37 a30a95d2ff
commit 5bfd60ba35
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
contributors/guide/github-workflow.md
View File

@ -237,6 +237,11 @@ For mass automated fixups such as automated doc formatting, use one or more
commits for the changes to tooling and a final commit to apply the fixup en commits for the changes to tooling and a final commit to apply the fixup en
masse. This makes reviews easier. masse. This makes reviews easier.
An alternative to this manual squashing process is to use the Prow and Tide based automation that is configured in GitHub: adding a comment to your PR with `/label tide/merge-method-squash` will trigger the automation so that GitHub squash your commits onto the target branch once the PR is approved. Using this approach simplifies things for those less familiar with Git, but there are situations in where it's better to squash locally; reviewers will have this in mind and can ask for manual squashing to be done.
By squashing locally, you control the commit message(s) for your work, and can separate a large PR into logically separate changes.
For example: you have a pull request that is code complete and has 24 commits. You rebase this against the same merge base, simplifying the change to two commits. Each of those two commits represents a single logical change and each commit message summarizes what changes. Reviewers see that the set of changes are now understandable, and approve your PR.
## Merging a commit ## Merging a commit
Once you've received review and approval, your commits are squashed, your PR is ready for merging. Once you've received review and approval, your commits are squashed, your PR is ready for merging.