brew/docs/BrewTestBot.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

38 lines
1.3 KiB
Markdown

---
logo: /assets/img/brewtestbot.png
image: /assets/img/brewtestbot.png
redirect_from:
- /Brew-Test-Bot
last_review_date: "1970-01-01"
---
# BrewTestBot
[`brew test-bot`](Manpage.md#test-bot-options-formula) is what runs the automated review and testing system funded by [our Kickstarter in 2013](https://www.kickstarter.com/projects/homebrew/brew-test-bot).
It comprises three Mac Pros hosting virtual machines, several Intel and M1 Mac minis and some cloud Ubuntu instances that run the [`test-bot.rb`](https://github.com/Homebrew/homebrew-test-bot) external command to perform bottle builds and automated testing of the full lifecycle of any change to Homebrew or its taps.
## Pull Requests
The bot automatically builds pull requests and updates their status depending on the result of the job.
For example, a job which has been queued but not yet completed will have a section in the pull request that looks like this:
![Triggered Pull Request](assets/img/docs/brew-test-bot-triggered-pr.png)
---
A failed build looks like this:
![Failed Pull Request](assets/img/docs/brew-test-bot-failed-pr.png)
---
A passed build that's been approved to merge looks like this:
![Passed Pull Request](assets/img/docs/brew-test-bot-passed-pr.png)
---
On failed or passed builds you can click the "Details" link for each check to view its output in GitHub Actions.