brew/docs/BrewTestBot-For-Maintainers.md
Issy Long 31d7bcc583
Add a last_reviewed_date to docs metadata
- At the AGM we formed an ad-hoc documentation working group.
- One of our ideas was that we should have a last reviewed date for
  documentation, so that we can periodically implement a review
  mechanism (GitHub Actions posts to Slack for a regular documentation
  outdatedness check?) to track how old docs are and ensure they're
  still relevant.
- This is a first step towards that goal, by adding a `last_review_date`
  to the metadata of all docs with a date of earlier than Homebrew's
  inception because everything needs reviewing so that we start from a
  good base!
2025-02-03 11:56:07 +00:00

1.8 KiB

logo, image, redirect_from, last_review_date
logo image redirect_from last_review_date
/assets/img/brewtestbot.png /assets/img/brewtestbot.png
/Brew-Test-Bot-For-Core-Contributors
1970-01-01

BrewTestBot for Maintainers

brew test-bot is the command our CI runs to test and build bottles for formulae.

Publishing Bottles

If CI is passing on a pull request and it doesn't need any modifications (e.g. commit message, revision bump, etc.):

  1. Review and approve the pull request. Be sure to thank the contributor!
  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.

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.

If a pull request won't be automatically merged by BrewTestBot (has the labels autosquash, automerge-skip, ornew formula, or has some kind of acceptable CI failure):

  1. Ensure that bottles have built successfully.
  2. Run brew pr-publish 12345 where 12345 is the pull request number (or URL).
  3. Watch the actions queue to ensure your job finishes. BrewTestBot will notify you of failures with a ping as well.

If a pull request needs its commit messages changed in a way that autosquash doesn't support (has the label automerge-skip):

  1. Ensure that bottles have built 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 to the pull request.