2024-02-15 14:50:24 -05:00
---
logo: /assets/img/brewtestbot.png
image: /assets/img/brewtestbot.png
redirect_from:
- /Brew-Test-Bot-For-Core-Contributors
2025-02-03 10:59:02 +00:00
last_review_date: "1970-01-01"
2024-02-15 14:50:24 -05:00
---
2024-02-09 23:25:46 -06:00
# BrewTestBot for Maintainers
2017-01-04 16:16:00 -06:00
2024-02-15 14:50:24 -05:00
[`brew test-bot` ](Manpage.md#test-bot-options-formula ) is the command our [CI ](https://github.com/BrewTestBot ) runs to test and build bottles for formulae.
2014-10-26 14:54:36 +00:00
2024-02-09 23:25:46 -06:00
## Publishing Bottles
2020-04-11 12:44:39 +10:00
2024-02-09 23:25:46 -06:00
If CI is passing on a pull request and it doesn't need any modifications (e.g. commit message, revision bump, etc.):
2014-10-26 14:54:36 +00:00
2020-10-13 23:18:47 +11:00
1. Review and approve the pull request. Be sure to thank the contributor!
2024-02-09 23:25:46 -06:00
2. Wait for BrewTestBot to automatically merge the pull request. This job usually starts within a minute if both of the following are true:
- The pull request is approved by a maintainer who has write access to homebrew-core.
- CI is passing.
2020-10-13 23:18:47 +11:00
2024-02-09 23:25:46 -06:00
If any jobs did not complete successfully, the pull request will not automatically merge. Additionally, BrewTestBot will comment on the pull request if there is a publishing failure.
2020-10-13 23:18:47 +11:00
2024-02-09 23:25:46 -06:00
If a pull request won't be automatically merged by BrewTestBot (has the labels `autosquash` , `automerge-skip` , or`new formula` , or has some kind of acceptable CI failure):
1. Ensure that bottles have built successfully.
2020-04-11 12:44:39 +10:00
2. Run `brew pr-publish 12345` where `12345` is the pull request number (or URL).
2024-02-09 23:25:46 -06:00
3. Watch the [actions queue ](https://github.com/Homebrew/homebrew-core/actions ) to ensure your job finishes. BrewTestBot will notify you of failures with a ping as well.
2014-10-26 14:54:36 +00:00
2020-10-13 23:18:47 +11:00
If a pull request needs its commit messages changed in a way that autosquash doesn't support (has the label `automerge-skip` ):
2020-10-03 16:41:17 +10:00
2024-02-09 23:25:46 -06:00
1. Ensure that bottles have built successfully.
2020-10-03 16:41:17 +10:00
2. Run `brew pr-pull 12345` where `12345` is the pull request number (or URL).
2024-02-09 23:25:46 -06:00
3. Amend any relevant commits if needed, then run `git push` to push the commits to the pull request.
2025-02-03 15:13:31 +01:00
## Rebottling
2025-02-03 17:40:13 +01:00
If a formula in homebrew-core needs rebottling for any reason:
2025-02-03 15:13:31 +01:00
2025-02-03 17:42:50 +01:00
1. Navigate to [homebrew-core's rebottling workflow page ](https://github.com/Homebrew/homebrew-core/actions/workflows/dispatch-rebottle.yml )
2. Click on the "Run workflow" button on the right of the page.
3. Fill out any necessary fields.