Update: I’d suggest anyone reading this post to use a GitHub organization with multi-branch pipelines rather than the GHPRB plugin below.

Ever since I began converting the Jenkins jobs at my organization to scripted pipelines, I’ve been frustrated that the GitHub Pull Request Builder plugin only has documentation for using it in a declarative pipeline. Several Google searches lead me to various GitHub open issues, but it didn’t seem like anyone was really using this functionality. After finally giving into frustration I decided to dedicate some time to it and get it working. Below is a working example of a Jenkins scripted pipeline using GHPRB.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

#!/bin/groovy
import org.kohsuke.github.GHCommitState;

node {
  try {
    properties([
      buildDiscarder(logRotator(artifactNumToKeepStr: '20', numToKeepStr: '20')),
      parameters([
        string(name: 'GIT_REPO', defaultValue: 'git@github.com:MyOrg/UI.git', description: 'Git repo'),
        [$class: 'GitParameterDefinition', branch: 'origin/master', branchFilter: '.*', defaultValue: '', description: 'Git tag', name: 'TAG', quickFilterEnabled: false, selectedValue: 'NONE', sortMode: 'DESCENDING_SMART', tagFilter: '*', type: 'PT_TAG'],
      ]),
      [$class: 'GithubProjectProperty', displayName: '', projectUrlStr: 'https://github.com/MyOrg/UI/'],
      [$class: 'org.jenkinsci.plugins.workflow.job.properties.PipelineTriggersJobProperty', triggers:[
        [
          $class: 'org.jenkinsci.plugins.ghprb.GhprbTrigger',
          orgslist: 'MyOrg',
          cron: 'H/5 * * * *',
          triggerPhrase: 'special trigger phrase',
          onlyTriggerPhrase: true,
          useGitHubHooks: true,
          permitAll: true,
          autoCloseFailedPullRequests: false,
          displayBuildErrorsOnDownstreamBuilds: true,
          extensions: [
            [
              $class: 'org.jenkinsci.plugins.ghprb.extensions.status.GhprbSimpleStatus',
              commitStatusContext: 'Docker Build',
              showMatrixStatus: false,
              triggeredStatus: 'Starting job...',
              startedStatus: 'Building...',
              completedStatus: [
                [$class: 'org.jenkinsci.plugins.ghprb.extensions.comments.GhprbBuildResultMessage', message: 'Done', result: GHCommitState.SUCCESS],
                [$class: 'org.jenkinsci.plugins.ghprb.extensions.comments.GhprbBuildResultMessage', message: 'Failed', result: GHCommitState.FAILURE]
              ]
            ]
          ]
        ]
      ]]
    ])

    stage('Checkout') {
      checkout([$class: 'GitSCM', branches: [[name: 'origin/master']], doGenerateSubmoduleConfigurations: false, extensions: [], submoduleCfg: [], userRemoteConfigs: [[credentialsId: 'MyOrg github', url: params.GIT_REPO]]])
    }
  } catch (Exception ex) {
    currentBuild.result = 'FAILURE'
    echo ex.toString()

    // Throw RejectedAccessException again if its a script privilege error
    if (ex.toString().contains('RejectedAccessException')) {
      throw ex
    }
  }
}

An important note: This will throw various Jenkins sandbox security warnings, which can be allowed @ https://jenkins.yourorg.com/scriptApproval/

Hopefully this helps others in their search for documentation :D