This plugin integrates Jenkins with Github projects.
The plugin currently has three major functionalities:
- Create hyperlinks between your Jenkins projects and GitHub
- Trigger a job when you push to the repository by groking HTTP POSTs from post-receive hook and optionally auto-managing the hook setup.
- Report build status result back to github as Commit Status (documented on SO)
Hyperlinks between changes
The Github plugin decorates Jenkins "Changes" pages to create links to your Github commit and issue pages. It adds a sidebar link that links back to the Github project page.
When creating a job, specify that is connects to git. Under "Github project", put in: email@example.com:Person/Project.git Under "Source Code Management" select Git, and put in firstname.lastname@example.org:Person/Project.git
Trigger a build when a change is pushed to GitHub
To use this feature:
Step 1. Go to the global configuration and choose the mode in which Jenkins manages post-receive hooks in your GitHub repositories.
- Automatic Mode: in this mode, Jenkins will automatically add/remove hook URLs to GitHub based on the project configuration in the background. You'll specify GitHub user names and password OAuth token so that Jenkins can login as you to do this, and yes, we need your password and not API token because GitHub doesn't have an API for managing post-commit hooks.
- Manual Mode: in this mode, you'll be responsible for registering the hook URLs to GitHub. Click the icon to see the URL in Jenkins that receives the post-commit POSTs.
Step 2. Open "Manage Jenkins > Configure Global Security" page and make sure that "Grant READ permissions for /github-webhook" is enabled in the "GitHub Authorization Settings" section. (If you are using the latest version of the plugin, you may not see the Github option on "Configure Global Security" page. Just go to the project configure page, in section "Build Triggers", check "Build when a change is pushed to GitHub")
Step 3. Once that configuration is done, go to the project config of each job you want triggered automatically and simply check "Build when a change is pushed to GitHub" under "Build Triggers". With this, every new push to the repository automatically triggers a new build.
Note that there's only one URL and it receives all post-receive POSTs for all your repositories. The server side of this URL is smart enough to figure out which projects need to be triggered, based on the submission.
This plugin requires that you have an HTTP URL reachable from GitHub, which means it's reachable from the whole internet. So it is implemented carefully with the possible malicious fake post-receive POSTS in mind. To cope with this, upon receiving a POST, Jenkins will talk to GitHub to ensure the push was actually made.
Jenkins inside a firewall
In case your Jenkins run inside the firewall and not directly reachable from the internet, this plugin lets you specify an arbitrary endpoint URL as an override in the automatic mode. The plugin will assume that you've set up reverse proxy or some other means so that the POST from GitHub will be routed to the Jenkins.
If you set this up but build aren't triggered, check the following things:
- Click the "admin" button on the GitHub repository in question and make sure post-receive hooks are there.
- If it's not there, make sure you have proper credential set in the Jenkins system config page.
- Also, enable logging for the class name
com.cloudbees.jenkins.GitHubPushTrigger and you'll see the log of Jenkins trying to install a post-receive hook.
- enable logging for the class name
com.cloudbees.jenkins.GitHubWebHook. Click "Test hook" button from the GitHub UI and see if you see
GitHubWebBook receive a payload.
- How does this relate to the normal Git plugin? Is it also needed, or does it replace it? Does it offer the same functionality? Why is this even needed?
- Does this only work with the public github or also private github instances?
- Maybe also document some if this plugins limitations
Possible Issues between Jenkins and GitHub
- In windows, Jenkins will use the the SSH key of the user it is running as, which is located in the %USERPROFILE%\.ssh folder ( on XP, that would be C:\Documents and Settings\USERNAME\.ssh, and on 7 it would be C:\Users\USERNAME\.ssh). Therefore, you need to force Jenkins to run as the user that has the SSH key configured. To do that, right click on My Computer, and hit "Manage". Click on "Services". Go to Jenkins, right click, and select "Properties". Under the "Log On" tab, choose the user Jenkins will run as, and put in the username and password (it requires one). Then restart the Jenkins service by right clicking on Jenkins (in the services window), and hit "Restart".
- Jenkins does not support passphrases for SSH keys. Therefore, if you set one while running the initial Github configuration, rerun it and don't set one.
Version 1.11.2 (Feb 25, 2015)
- Added "re-register" button in global page for re-registering hooks (JENKINS-25127)
Version 1.11.1 (Mar 26, 2015)
Version 1.11 (Feb 25, 2015)
- Refer builds in commit status context (JENKINS-23995)
- Upgrade github-api-plugin dependency to 1.59
Version 1.10 (Nov 17, 2014)
- Build step to set Github commit status as "pending"
- Prevent NPE in
GitHubCommitNotifier if Git checkout fails (JENKINS-23641)
NoClassDefFoundError when Multiple SCMs Plugin is not present
- Make the build status configurable if
GitHubCommitNotifier fails (JENKINS-25312)
- Improved error checks in the global configuration page.
- Resolve variables in GitHub repository URL
Version 1.9.1 (Jul 16, 2014)
- Fixed "Github Webhook event of type null is not supported" (JENKINS-23661)
Version 1.9 (Jul 1, 2014)
- Webhook auto management now works with GitHub Enterprise (JENKINS-18710)
- GitHub Web Hook does not work unless "Prevent Cross Site Request Forgery exploits" is disabled (JENKINS-20140)
Version 1.7 (Jul 7, 2013)
- Add the name of the user who pushed to Github into the log (pull #17).
- Recognize GitHub repository URLs that doesn't end with ".git"
- Got rid of API token and added OAuth token for interacting with GitHub.
- Webhook support is no longer a pre-requisite for commit status notification (JENKINS-18165)
Version 1.4 (Jun 13, 2012)
- Removed GitHub V2 API dependency
Version 1.3 (May 31, 2012)
- Improved to use the new Jenkins hook type available in GitHub
- Change GitHubPushCause to extend from SCMTriggerCause (pull #15).
Version 1.2 (Mar 13, 2012)
- Refactored to enable GitHub SQS plugin (pull #13).
Version 1.1 (Feb 11, 2012)
- URL normalisation corrupts urls where the project name legitimately ends in 'tree/' (pull #10).
- Global configuration not saved since Jenkins 1.445 (JENKINS-12487).
- Also trigger jobs with GitHub repositories configured via MultipleSCMs plugin (pull #12).
- Match git http:// urls which don't container a username@host since these are valid.
Version 1.0 (Jan 11, 2012)
- the post-receive hook handling was not poking read-protected projects.
Version 0.9 (Jan 4, 2012)
- Fixed a bug in handling organization's private repository pull #4
- Updated to use a newer version of the github-api library.
Version 0.7 (Aug 27, 2011)
- Supported ssh-based access to GitHub. pull #4
- Fixed a bug in GitHub repository pattern matching that didn't allow "." in the name pull #3
Version 0.6 (Jul 21, 2011)
- Added JGit explicitly to improve interaction with the Git plugin
Version 0.5 (Jun 10, 2011)
- Added support for post-receive trigger
Version 0.4 (Feb 14, 2011)
Version 0.2 (Jun 25, 2009)