docs: update for autosquash dispatching

This commit is contained in:
Jonathan Chang 2020-10-03 16:41:17 +10:00
parent 8ac9608787
commit dbab49fa1f
2 changed files with 7 additions and 2 deletions

View File

@ -14,5 +14,10 @@ If a pull request is correct and doesn't need any modifications to commit messag
If a pull request needs its commits squashed or its commit messages reformatted to [follow our style](https://docs.brew.sh/Formula-Cookbook#commit):
1. Ensure the job has already completed successfully.
2. Run `brew pr-pull --autosquash 12345` where `12345` is the pull request number (or URL). For revision bumps, rebuilds, and formula deletions, you can optionally include a `--message` argument to explain the change.
2. Run `brew pr-publish --autosquash 12345` where `12345` is the pull request number (or URL). For revision bumps, rebuilds, and formula deletions, you can optionally include a `--message` argument to explain the change.
If a pull request needs its commit messages changed in a way that autosquash doesn't support:
1. Ensure the job has already completed successfully.
2. Run `brew pr-pull 12345` where `12345` is the pull request number (or URL).
3. Amend any relevant commits if needed, then run `git push` to push the commits.

View File

@ -55,7 +55,7 @@ Check for:
- formula `bottle :unneeded`, you can merge it through GitHub UI
- bottles need to be pulled, and...
- the commits are correct and don't need changes, approve the PR to trigger an automatic merge (use `brew pr-publish $PR_ID` to trigger manually in case of a new formula)
- the commits need to be squashed, use `brew pr-pull --autosquash $PR_ID` and `git push`
- the commits need to be squashed, use `brew pr-publish --autosquash $PR_ID` and `git push`
- the commits need to be amended, use `brew pr-pull $PR_ID`, make changes, and `git push`
- don't forget to thank the contributor
- celebrate the first-time contributors