From 7deb6a16177ecc6681ed0c0909d443d64f0ef9f1 Mon Sep 17 00:00:00 2001 From: Chris Rebert Date: Thu, 20 Nov 2014 22:11:09 -0800 Subject: Fixes #8 --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 49453ef..ed4b731 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ Savage [![Build Status](https://travis-ci.org/twbs/savage.svg?branch=master)](https://travis-ci.org/twbs/savage) Savage is a service watches for new or updated pull requests on a given GitHub repository. For each pull request, it evaluates whether the changes are "safe" (i.e. we can run a Travis CI build with them with heightened permissions without worrying about security issues) and "interesting" (i.e. would benefit from a Travis CI build with them with heightened permissions), based on which files were modified. If the pull request is "safe" and "interesting", then it initiates a Travis CI build with heightened permissions on a specified GitHub repository. When the Travis CI build completes, it posts a comment with the test results on the pull request. If the test failed, the pull requester can then revise their code to fix the problem. +Users who are members of trusted GitHub organizations (see the `trusted-orgs` setting) can ask Savage to retry a pull request by leaving a comment on the pull request of the form: "@ retry" (e.g. "@twbs-savage retry") Savage's original use-case is for running Sauce Labs cross-browser JS tests on pull requests via Travis CI, while keeping the Sauce Labs access credentials secure. @@ -64,6 +65,8 @@ savage { github-test-repo = "twbs/bootstrap-tests" // Ignore pull requests whose branch is from the watched repo (and is thus from a project team member) ignore-branches-from-watched-repo = true + // List of GitHub organization names whose users Savage should trust to authorize retries of builds + trusted-orgs = [ "twbs" ] // List of Unix file globs constituting the whitelist of safely editable files whitelist = [ "**.md", @@ -108,7 +111,7 @@ savage { * Payload URL: `http://your-domain.example/savage/github` * Content type: `application/json` * Secret: Same as your `web-hook-secret-key` config value -* Which events would you like to trigger this webhook?: "Pull Request" +* Which events would you like to trigger this webhook?: "Pull Request" and "Issue comment" ### Travis webhook configuration In `.travis.yml`: -- cgit v1.2.3