admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

docs: update for new autosquash on automerge

Browse Source
This commit is contained in:
Jonathan Chang 2020-10-13 23:18:47 +11:00
parent b07ff7df56
commit 53cfa0f95f
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/Brew-Test-Bot-For-Core-Contributors.md
View File

@ -6,17 +6,17 @@ If a build has run and passed on `brew test-bot` then it can be used to quickly
If a pull request is correct and doesn't need any modifications to commit messages or otherwise: If a pull request is correct and doesn't need any modifications to commit messages or otherwise:
1. Review and approve the pull request. Be sure to thank the contributor!
2. Wait for BrewTestBot to automatically merge the pull request. This happens about once an hour. BrewTestBot will comment if there is a failure.
If a pull request won't be automatically merged by Brew Test Bot (has the labels `do not merge`, `new formula`, or `automerge-skip`), but the [commit messages and commit style](Formula-Cookbook.md#commit) are correct:
1. Ensure the job has already completed successfully. 1. Ensure the job has already completed successfully.
2. Run `brew pr-publish 12345` where `12345` is the pull request number (or URL). 2. Run `brew pr-publish 12345` where `12345` is the pull request number (or URL).
- Approving a PR for an existing formula will automatically publish the bottles and close the PR, taking care of this step. - Approving a PR for an existing formula will automatically publish the bottles and close the PR, taking care of this step.
3. Watch the [actions queue](https://github.com/Homebrew/homebrew-core/actions) to ensure your job finishes. BrewTestBot will usually notify you of failures with a ping as well. 3. Watch the [actions queue](https://github.com/Homebrew/homebrew-core/actions) to ensure your job finishes. BrewTestBot will usually notify you of failures with a ping as well.
If a pull request needs its commits squashed or its commit messages reformatted to [follow our style](https://docs.brew.sh/Formula-Cookbook#commit): If a pull request needs its commit messages changed in a way that autosquash doesn't support (has the label `automerge-skip`):
1. Ensure the job has already completed successfully.
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. 1. Ensure the job has already completed successfully.
2. Run `brew pr-pull 12345` where `12345` is the pull request number (or URL). 2. Run `brew pr-pull 12345` where `12345` is the pull request number (or URL).

4
docs/Homebrew-homebrew-core-Merge-Checklist.md
View File

@ -54,8 +54,8 @@ Check for:
- if CI is green and... - if CI is green and...
- formula `bottle :unneeded`, you can merge it through GitHub UI - formula `bottle :unneeded`, you can merge it through GitHub UI
- bottles need to be pulled, and... - 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 are correct, don't need changes, and BrewTestBot can merge it (doesn't have the label `automerge-skip`): 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-publish --autosquash $PR_ID` and `git push` - the commits are correct and don't need changes, but BrewTestBot can't merge it (has the label `automerge-skip`), use `brew pr-publish $PR_ID`
- the commits need to be amended, use `brew pr-pull $PR_ID`, make changes, 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 - don't forget to thank the contributor
- celebrate the first-time contributors - celebrate the first-time contributors