View GitHub on the plugin site for more information.
Older versions of this plugin may not be safe to use. Please review the following warnings before using an older version:
This plugin integrates Jenkins with Github projects.
The plugin currently has two 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.
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: firstname.lastname@example.org:Person/Project.git Under "Source Code Management" select Git, and put in email@example.com:Person/_Project._git
Trigger a build when a change is pushed to GitHub
To use this feature, first 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 passwords 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.
Once that configuration is done, go to the project config 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.
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 Settinsusername\.ssh, and on 7 it would be C:\Usersusername\.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.1 (Upcoming)
- 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)
- Remove unused code