Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This plugin is configured to build pull requests that are opened against repositories within the UnionVMS organisation. Each repository needs to be configured separately and the below table shows the currently configured repositories.

Repository nameJenkins jobTarget branchExecuting GitHub userWhitelisted users
UVMS-TEST-REPOUVMS-TEST-REPO-Pull-RequestsdevelopmentFOCUSBOTUsers that are part of the UnionVMS organisation










The plugin is configured globally, i.e. in the Jenkins system settings, and per job. The job configuration can complement some of the global configurations.

Global configuration items of importance are listed below. The rest of the global configuration items have been left at their default values.

Global configuration itemValue
GitHub Server API URLhttps://api.github.com
Jenkins URL overrideNot set
Shared secretNot set
Credentialshttps://api.github.com GitHub auto generated token credentials
Auto-manage webhooksChecked
Info

Note: The global configuration allows setting default values for scheduling, administrators, build trigger messages. These default values are then used within the job configurations. It could be worth adding administrators here.

A typical job configuration can be found in the configuration of UVMS-TEST-REPO-Pull-Requests.

Job configuration itemValue
General section
GitHub ProjectURL to the project in GitHub, e.g. https://github.com/UnionVMS/UVMS-TEST-REPO/
Source Code Management section
GitSelected
Repository URLThe URL to the repository as written in a git clone command, e.g. https://github.com/UnionVMS/UVMS-TEST-REPO.git
CredentialsThe GitHub user credentials, i.e. the ones specified for general GitHub access, not the API-tokens defined as part of the global configuration of the GitHub Pull Request Builder plugin
Name (under advanced)origin
Refspec (under advanced)+refs/pull/*:refs/remotes/origin/pr/* (to also build branches, change to +refs/heads/*:refs/remotes/origin/* +refs/pull/*:refs/remotes/origin/pr/*)
Branches to build${sha1}
Build Triggers section
GitHub Pull Request BuilderSelected
GitHub API credentialsSelect one of those defined in the global configuration, e.g. "https://api.github.com GitHub auto generated token credentials"
Crontab Line (under advanced)The polling interval. For instance, for every third minute, set to H/3 * * * *. Note that it is recommended to configure a web-hook instead of using polling.
Whitelist (under advanced)

uvms

List of users whose pull requests are allowed to be built without the confirmation of an admin.

List of organizations (under advanced)

UnionVMS

Organisations whose members should be automatically whitelisted.

Post-build Actions section
Set GitHub commit status (universal)Selected
Commit SHALatest build revision
RepositoriesAny defined in job repository
Commit contextFrom GitHub property with fallback to job name
Status resultBased on build result manually defined
Status backrefBackref to the build


GitHub Pull Request Builder - Everyday work

The pull request builder jobs have been configured to listen for pull request changes in GitHub. If the job succeeds, then the pull request information will be updated in GitHub. Note that the current configuration does not require the pull request to have successful builds associated with it in order for a user to merge the pull request. This can be configured in GitHub. During the build, the pull request will indicate that there is a build pending.

Build pending:

Image Added

Build completed successfully:

Image Added

Build details (theĀ Details-link is a link to the build in Jenkins):

Image Added

The jobs can also be configured so that they can be manually triggered from Jenkins or from GitHub.

...

It is however even easier to trigger the build manually from within GitHub, and more specifically from within the open merge request. To do this, simply add a comment saying "test this please":

If a GitHub user is not whitelisted in Jenkins, Jenkins will post a comment to the pull request in GitHub asking a whitelisted user to accept the pull request for build. Without this check, any user could open a pull request against the repository and this way have Jenkins executing their potentially harmful code.