GitHub pull request builder plugin

Skip to end of metadata
Go to start of metadata

This plugin builds pull requests in github and report results.

Plugin Information

Plugin ID ghprb Changes In Latest Release
Since Latest Release
Latest Release
Latest Release Date
Required Core
Dependencies
1.11.2
Mar 13, 2014
1.480
github (version:1.5)
github-api (version:1.42)
git (version:1.1.17)
Source Code
Issue Tracking
Maintainer(s)
GitHub
Open Issues
Honza Br��zdil (id: janinko)
Valdis Rigdon (id: valdisrigdon)
Usage Installations 2013-Apr 1084
2013-May 1163
2013-Jun 1295
2013-Jul 1396
2013-Aug 1489
2013-Sep 1601
2013-Oct 1751
2013-Nov 1844
2013-Dec 1912
2014-Jan 2070
2014-Feb 2205
2014-Mar 2409

Commands: 

When a new pull request is opened in the project and the author of the pull request isn't white-listed, builder will ask "Can one of the admins verify this patch?".

  • "ok to test" to accept this pull request for testing
  • "test this please" for a one time test run
  • "add to whitelist" to add the author to the whitelist

If the build fails for other various reasons you can rebuild.

  • "retest this please" to start a new build

Installation:

  • I recommend to create GitHub 'bot' user that will be used for communication with GitHub (however you can use your own account if you want).
  • The user needs to have push rights for your repository (must be collaborator (user repo) or must have Push & Pull rights (organization repo)).
  • If you want to use GitHub hooks have them set automatically the user needs to have administrator rights for your repository (must be owner (user repo) or must have Push, Pull & Administrative rights (organization repo))
  • Install the plugin.
  • Go to "Manage Jenkins" -> "Configure System" -> "Github pull requests builder" section.
  • If you are using Enterprise GitHub set the server api URL in "Github server api URL". Otherwise leave there "https://api.github.com".
  • Set your 'bot' user's Access Token.
    • If you don't have generated your access token you can generate one in "Advanced...".
      • Set your 'bot' user's GitHub username and password.
      • Press the "Create Access Token" button
      • Copy the generated Access Token into the field "Access Token"
      • Clear the username and password fields
    • If you don't want to use Access Token leve the field empty and fill the username and password in "Advanced...".
  • Add GitHub usernames of admins (these usernames will be used as defaults in new 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. This specify default setting for new jobs.
    • The target branch whitelist.  This allows you to test only pull requests targeted for the branches in this list.
    • If you want to get comments posted to GitHub for each build, fill the "Published Jenkins URL", if you only want to use the GitHub status API, leave it empty.
  • Save to preserve your changes.

Creating 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.
    • If you want to use GitHub hooks for automatic testing, read the help for "Use github hooks for build triggering" in job configuration. Then you can check the checkbox.
    • In Advanced, you can modify:
      • The crontab line for this specific job. This schedules polling to GitHub for new changes in Pull Requests.
      • The whitelisted users for this specific job.
      • The organisation names 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").

Changelog

1.11.2

Major reduction in the number of requests made to GitHub to avoid rate limit issues
Fixed changelog for a build so it reports differences between Pull Request build
Fixes bug on getting author email address from GitHub APIs
Updates warning message is URL isn't set on the GitHub project plugin
Adds some additional parameters to the build, such as the source branch, pull request link, etc.
Success/failure message now put into the comment on Pull Requests

1.10 - 1.11.1

Not publicly released.

1.9

Added job specific triggers.
Added more informations as job parameters.
Fix support for gh-ent token generation. JENKINS-17334
Lookup PR detailed information for each PR. JENKINS-17852
Fix closing PR.
various bugfixes

1.8

Support autoclose at build level
add pull id and target branch to environment variables
fix GitHub Hooks when authentication is required on Jenkins
various bugfixes and improvements

1.7

implemented support for GitHub hooks
added button for generating api token

1.6

option for specifing how to mark unstable builds in github
Close failed pull requests automatically if plugin admin configured it
customizeable pass/fail comments
Refactoring of code
help description in Jenkins configuration

1.5

checkbox enabling sending comments when update of comment status fails
option to enter organisations which members are whitelisted
support for enterprise Git Hub
link to pullrequest into build description
fixes

1.4

Changed comment commands - phrases for testing once, pullrequest or add user to whitelist
"test this please" starts new build
"ok to test" allow pullrequest for building
"add to whitelist" add user to whitelist

1.3

Add published URL feature.
Enable connection to github enterprise instances.
Enable authentication via a token.
When automatic merge is possible, build the merge.

1.2

Use commit status api instead of comments for reporting results.

Labels

Edit
plugin-trigger plugin-trigger Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

Add Comment