Skip to content

GitHub integration

Fred G edited this page Nov 19, 2024 · 2 revisions

If this hasn't been set up already, please open a HelpDesk issue and request this feature.

Here are some details about what happens during the setup process:

  • A GitHub bot user will be created and added to the respective team on GitHub.
  • The credentials of the GitHub bot user will be added to the JIPP.
  • A webhook that can trigger builds on pushes or pull requests will be set up.

Once the ticket is resolved, you should be able to configure and use the GitHub integration in your jobs.

GitHub Branch Source Plugin (Recommended)

The GitHub Branch Source Plugin is the recommended plugin to integrate GitHub with Jenkins. It can only be used with Jenkins pipelines in Jenkinsfiles.

This plugin is installed by default on all Jenkins instances at the Eclipse Foundation.

Instruction how to set up GitHub multi-branch jobs can be found here: https://docs.cloudbees.com/docs/cloudbees-ci/latest/cloud-admin-guide/github-branch-source-plugin

GitHub Pull Request Builder Plugin (Deprecated)

The GitHub Pull Request Builder Plugin (GHPRB) allows to build/test pull requests and provide immediate feedback in the pull request on GitHub with freestyle jobs. It's recommended to switch to the GitHub Branch Source Plugin instead.

This plugin is installed by default on all Jenkins instances at the Eclipse Foundation.

Instructions how to set up GHPRB plugin in jobs can be found here: https://github.com/jenkinsci/ghprb-plugin/blob/master/README.md