brew/docs/Brew-Test-Bot.md

# 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)

---
Import docs from wiki. Closes Homebrew/homebrew#33211. 2014-10-26 14:54:36 +00:00			`# Brew Test Bot`
docs: fix titles on docs.brew.sh 2017-01-04 16:16:00 -06:00
Import docs from wiki. Closes Homebrew/homebrew#33211. 2014-10-26 14:54:36 +00:00			`brew test-bot` is the name for the automated review and testing system funded
Use more https links and some link updates along the way Closes Homebrew/homebrew#35529. Signed-off-by: Jack Nagel <jacknagel@gmail.com> 2015-01-04 04:27:16 +01:00			`by [our Kickstarter in 2013](https://www.kickstarter.com/projects/homebrew/brew-test-bot).`
Import docs from wiki. Closes Homebrew/homebrew#33211. 2014-10-26 14:54:36 +00:00
docs: add two taps, update CI info and fix some wording. 2018-02-01 16:04:21 -05:00			`It comprises four Mac Minis and three Xserves running in two data centres which host`
Update jenkins.brew.sh links. These previously, incorrectly pointed to bot.brew.sh. Fixes #2703. 2017-05-30 19:14:40 +01:00			`[a Jenkins instance at https://jenkins.brew.sh](https://jenkins.brew.sh) and run the`
docs: update Brew Test Bot screen shots 2017-03-11 13:46:20 -05:00			[`brew-test-bot.rb`](https://github.com/Homebrew/homebrew-test-bot/blob/master/cmd/brew-test-bot.rb)
Import docs from wiki. Closes Homebrew/homebrew#33211. 2014-10-26 14:54:36 +00:00			`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.`

docs: update Brew Test Bot screen shots 2017-03-11 13:46:20 -05:00			`For example, a job which has been queued but not yet completed will have a`
Grammar fixes for docs Fixes to spelling and punctuation for consistency and readability. 2017-02-23 12:20:07 -05:00			`section in the pull request that looks like this:`
Import docs from wiki. Closes Homebrew/homebrew#33211. 2014-10-26 14:54:36 +00:00
docs.brew.sh: use brew.sh theming. Unfortunately there's no easy way to share this code with the brew.sh site but it's at least able to have the `css/`, `img/` (root) and `_layouts` directories in sync between the two repositories. Some small CSS tweaks were needed to make these pages render more attractively. 2017-03-05 15:25:51 +00:00			`![Triggered Pull Request](img/docs/brew-test-bot-triggered-pr.png)`
Import docs from wiki. Closes Homebrew/homebrew#33211. 2014-10-26 14:54:36 +00:00
			`---`

			`A failed build looks like this:`

docs.brew.sh: use brew.sh theming. Unfortunately there's no easy way to share this code with the brew.sh site but it's at least able to have the `css/`, `img/` (root) and `_layouts` directories in sync between the two repositories. Some small CSS tweaks were needed to make these pages render more attractively. 2017-03-05 15:25:51 +00:00			`![Failed Pull Request](img/docs/brew-test-bot-failed-pr.png)`
Import docs from wiki. Closes Homebrew/homebrew#33211. 2014-10-26 14:54:36 +00:00
			`---`

			`A passed build looks like this:`

docs.brew.sh: use brew.sh theming. Unfortunately there's no easy way to share this code with the brew.sh site but it's at least able to have the `css/`, `img/` (root) and `_layouts` directories in sync between the two repositories. Some small CSS tweaks were needed to make these pages render more attractively. 2017-03-05 15:25:51 +00:00			`![Passed Pull Request](img/docs/brew-test-bot-passed-pr.png)`
Import docs from wiki. Closes Homebrew/homebrew#33211. 2014-10-26 14:54:36 +00:00
			`---`

			`On failed or passed builds you can click the "Details" link to view the result`
			`in Jenkins.`

			`A passed build looks like this:`

docs.brew.sh: use brew.sh theming. Unfortunately there's no easy way to share this code with the brew.sh site but it's at least able to have the `css/`, `img/` (root) and `_layouts` directories in sync between the two repositories. Some small CSS tweaks were needed to make these pages render more attractively. 2017-03-05 15:25:51 +00:00			`![Passed Jenkins Build](img/docs/brew-test-bot-passed-jenkins.png)`
Import docs from wiki. Closes Homebrew/homebrew#33211. 2014-10-26 14:54:36 +00:00
			`---`

			`A failed build looks like this:`

docs.brew.sh: use brew.sh theming. Unfortunately there's no easy way to share this code with the brew.sh site but it's at least able to have the `css/`, `img/` (root) and `_layouts` directories in sync between the two repositories. Some small CSS tweaks were needed to make these pages render more attractively. 2017-03-05 15:25:51 +00:00			`![Failed Jenkins Build](img/docs/brew-test-bot-failed-jenkins.png)`
Import docs from wiki. Closes Homebrew/homebrew#33211. 2014-10-26 14:54:36 +00:00
			`---`

			`You can click the test results link`
Brew-Test-Bot: update links 2016-08-26 01:40:10 +01:00			(e.g. `brew-test-bot.el_capitan.install openssl`) to
Import docs from wiki. Closes Homebrew/homebrew#33211. 2014-10-26 14:54:36 +00:00			`view the failed test output:`

docs.brew.sh: use brew.sh theming. Unfortunately there's no easy way to share this code with the brew.sh site but it's at least able to have the `css/`, `img/` (root) and `_layouts` directories in sync between the two repositories. Some small CSS tweaks were needed to make these pages render more attractively. 2017-03-05 15:25:51 +00:00			`![Failed Test](img/docs/brew-test-bot-failed-test.png)`
Import docs from wiki. Closes Homebrew/homebrew#33211. 2014-10-26 14:54:36 +00:00
			`---`