DavidTolley / ghprb-plugin

github pull requests builder plugin for Jenkins

This plugin builds pull requests from github and reports the results.

https://wiki.jenkins-ci.org/display/JENKINS/Github+pull+request+builder+plugin

When a new pull request is opened in the project and the author of the pull request isn't whitelisted, builder will ask Can one of the admins verify this patch?. One of the admins can comment ok to test to accept this pullrequest for testing, test this please for one time test run and add to whitelist to add the author to the whitelist.

If an author of a pull request is whitelisted, adding a new pull request or new commit to an existing pull request will start a new build.

A new build can also be started with a comment: retest this please.

Requirements:

github-api plugin (https://wiki.jenkins-ci.org/display/JENKINS/GitHub+API+Plugin)
github plugin (https://wiki.jenkins-ci.org/display/JENKINS/Github+Plugin)
git plugin (https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin)

Pre-installation:

• Create a github 'bot' user for commenting in pull requests
• then add the bot as a collaborator for your repository (if you are using organizations, set the Push & Pull rights for the bot).

Installation:

• Install the plugin.
• Go to Manage Jenkins -> Configure System -> Github pull requests builder section.
• Set your bot's GitHub username and password.
• Add GitHub usernames of admins for all jobs.
• Under Advanced, you can modify:
  • The phrase for adding users to the whitelist via comment. (Java regexp)
  • The phrase for accepting a pullrequest for testing. (Java regexp)
  • The phrase for starting a new build. (Java regexp)
  • The crontab line.
• Save to preserve your changes.

Creating a job:

• Create a new job.
• Add the project's GitHub URL to the GitHub project field (the one you can enter into browser. eg: https://github.com/janinko/ghprb)
• Select Git SCM.
• Add your GitHub Repository URL.
• Under Advanced, set refspec to +refs/pull/*:refs/remotes/origin/pr/*.
• In Branch Specifier, enter ${sha1}.
• Under Build Triggers, check Github pull requests builder.
  • Add admins for this specific job.
  • Set the crontab line for this specific job
  • Set the whitelisted users for this specific job.
  • Set the organisations whose members are considered whitelisted for this specific job.
• Save to preserve your changes.

Make sure you DON'T have Prune remote branches before build advanced option selected, since it will prune the branch created to test this build.

If you want to manually build the job, in the job setting check This build is parameterized and add string parameter named sha1. When starting build give the sha1 parameter commit id you want to build or refname (eg: origin/pr/9/head).

Updates

-> 1.4

When updating to versions 1.4 phrases for retesting on existing pull requsts can stop working. The solution is comment in pull request with ok to test or remove and create the job. This is caused because there was change in phrases.