aboutsummaryrefslogtreecommitdiffstats
path: root/share/doc/homebrew/Brew-Test-Bot.md
diff options
context:
space:
mode:
Diffstat (limited to 'share/doc/homebrew/Brew-Test-Bot.md')
-rw-r--r--share/doc/homebrew/Brew-Test-Bot.md67
1 files changed, 67 insertions, 0 deletions
diff --git a/share/doc/homebrew/Brew-Test-Bot.md b/share/doc/homebrew/Brew-Test-Bot.md
new file mode 100644
index 000000000..dbb1bc46a
--- /dev/null
+++ b/share/doc/homebrew/Brew-Test-Bot.md
@@ -0,0 +1,67 @@
+# Brew Test Bot
+`brew test-bot` is the name for the automated review and testing system funded
+by [our Kickstarter in 2013](http://www.kickstarter.com/projects/homebrew/brew-test-bot).
+
+It comprises of four Mac Minis running in a data centre in England which host
+[a Jenkins instance at http://bot.brew.sh](http://bot.brew.sh) and run the
+[`brew-test-bot.rb`](https://github.com/Homebrew/homebrew/blob/master/Library/Homebrew/cmd/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
+
+There is [a brew test-bot mailing list on Google Groups](https://groups.google.com/forum/#!forum/brew-test-bot)
+which emails its members any failed builds that failed on the Homebrew master
+branch.
+
+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 started will have a
+section in the pull-request that looks like this:
+
+
+![Triggered Pull Request](brew-test-bot-triggered-pr.png)
+
+---
+
+A failed build looks like this:
+
+
+![Failed Pull Request](brew-test-bot-failed-pr.png)
+
+---
+
+A passed build looks like this:
+
+
+![Passed Pull Request](brew-test-bot-passed-pr.png)
+
+---
+
+On failed or passed builds you can click the "Details" link to view the result
+in Jenkins.
+
+When you click this you'll see the results.
+
+A passed build looks like this:
+
+
+![Passed Jenkins Build](brew-test-bot-passed-jenkins.png)
+
+---
+
+A failed build looks like this:
+
+
+![Failed Jenkins Build](brew-test-bot-failed-jenkins.png)
+
+---
+
+You can click the test results link
+(e.g. `brew-test-bot.Homebrew/homebrew/pull/22183-3c17deb.install embree`) to
+view the failed test output:
+
+![Failed Test](brew-test-bot-failed-test.png)
+
+---