brew/docs/Brew-Test-Bot.md
EricFromCanada 2020f382cb docs: add two taps, update CI info
and fix some wording.
2018-02-01 16:04:21 -05:00

58 lines
1.6 KiB
Markdown

# Brew Test Bot
`brew test-bot` is the name for the automated review and testing system funded
by [our Kickstarter in 2013](https://www.kickstarter.com/projects/homebrew/brew-test-bot).
It comprises four Mac Minis and three Xserves running in two data centres which host
[a Jenkins instance at https://jenkins.brew.sh](https://jenkins.brew.sh) and run the
[`brew-test-bot.rb`](https://github.com/Homebrew/homebrew-test-bot/blob/master/cmd/brew-test-bot.rb)
Ruby script to perform automated testing of commits to the master branch, pull
requests and custom builds requested by maintainers.
## 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](img/docs/brew-test-bot-triggered-pr.png)
---
A failed build looks like this:
![Failed Pull Request](img/docs/brew-test-bot-failed-pr.png)
---
A passed build looks like this:
![Passed Pull Request](img/docs/brew-test-bot-passed-pr.png)
---
On failed or passed builds you can click the "Details" link to view the result
in Jenkins.
A passed build looks like this:
![Passed Jenkins Build](img/docs/brew-test-bot-passed-jenkins.png)
---
A failed build looks like this:
![Failed Jenkins Build](img/docs/brew-test-bot-failed-jenkins.png)
---
You can click the test results link
(e.g. `brew-test-bot.el_capitan.install openssl`) to
view the failed test output:
![Failed Test](img/docs/brew-test-bot-failed-test.png)
---