Jenkins CI Integration¶

Integration Configuration¶

To configure an integration with Jenkins CI:

1. Navigate to the Administration UI -> Integrations.

2. Click Add Integration and select Jenkins CI.

3. Fill out the general fields:

   Name:

   A name for this particular configuration.

   Each integration must have its own name. You can provide any name you choose. This will be shown whenever a build is in progress.

   Enable this integration

   This will be on by default. You can turn this off to temporarily or permanently disable this Jenkins configuration without having to delete it.

   Local Site

   If you’re using the advanced Local Site (multi-server partition) support, you can specify which site contains this configuration.

   Most users can leave this blank.

4. Set the Conditions for when Review Board will trigger a build.

   At a minimum, you should set a condition to match a specific repository. Even if you only have one repository configured now, you’ll want to set this up so things don’t break if you connect a second one. If needed, you can create complex rules for which review requests get matched with this config (for example, if you only want to run a test suite for certain branches).

   

5. Fill out the address and authentication credentials for the Jenkins server handling your builds:

   Server:

   The base URL of your Jenkins server.

   Username:

   The username for a Jenkins user who has the appropriate permissions for starting the above Job name.

   API Token / Password:

   The API token used for authentication. Older versions may require the user’s password instead.

6. Fill out the information for the build processes in Jenkins.

   Job Name:

   This allows you to specify which job to run on your Jenkins server.

   This field allows for the following variables, which will be auto-populated with the appropriate fields from a review request:

   {branch_name}:

   The branch name.

   {repository_name}:

   The repository name.

   {noslash_branch_name}:

   The branch name with slashes converted to underscores.

   {noslash_repository_name}:

   The repository name with slashes converted to underscores.

   Older versions of Jenkins disallowed using slashes in job names, and required normalizing them to underscores. In newer versions, slashes are required. Use the appropriate variables for your version of Jenkins.

   Review Board API Token:

   This specifies the API token to use when configuring your Jenkins CI server.

   If you switch the local site, this will be regenerated upon saving.

7. Set the information for when to run builds.

   Run builds manually:

   Enable this if you want Jenkins builds to only run when manually started.

   When enabled, this will add a Run button to the build entry.

   Build timeout

   The amount of time until the build is considered to have timed out.

   If the build takes longer than this, it will be marked as timed out and can be re-run.

You can create multiple configurations of the integration to do builds for each repository which supports Jenkins builds.

Jenkins Plugin Installation¶

1. On your Jenkins server, navigate to Manage Jenkins, then select Manage Plugins.

2. On the plugins page, select the Available tab, then type “Review Board” into the Filter box. You should see one result (but you can click the link and verify that the ID listed is rb if multiple results appear).

3. Select the checkbox and click Install without restart.

4. Restart your Jenkins server.

Jenkins Configuration¶

To create a Review Board server configuration for your Jenkins server, perform the following steps:

1. On your Jenkins server, navigate to Manage Jenkins, then select Configure System.

2. Scroll down until you reach the Review Board configuration section.

3. Click Add Review Board Server to create a new Review Board server configuration.

4. Enter your Review Board server URL into the Review Board URL field. This must match exactly the server URL set in the Review Board General Settings page.

5. If you have previously created a credential for your Review Board API token, select it here and skip to the job configuration.

6. If you have not yet created a credential for the Review Board API token, click Add and select Jenkins.

7. In the prompt, set Kind to Secret text.

8. Set Scope to Global.

9. Fill in Secret with the Review Board API Token found in the Jenkins CI integration configuration page in the Review Board administration UI.

10. Give your secret a unique identifier in the ID field and click Add.

11. Click Save to save your server configuration.

For each job you wish to use on Jenkins, you must add four new build parameters that will be used to give Jenkins information on the incoming review request. To add these, perform the following steps:

1. Navigate to your job’s page and click Configure.

2. Ensure the This project is parameterized checkbox is checked.

3. For each of the following parameter names, repeat these two steps:

   • REVIEWBOARD_REVIEW_ID

   • REVIEWBOARD_REVIEW_BRANCH

   • REVIEWBOARD_DIFF_REVISION

   • REVIEWBOARD_STATUS_UPDATE_ID

   • REVIEWBOARD_SERVER

   1. Click Add parameter and select String parameter.

   2. Input the parameter name into Name and leave all other fields blank.

4. Scroll down to the Build section. Here we can add the Apply patch from Review Board step by clicking Add build step and choosing it from the dropdown menu.

   Note

   This step uses RBTools to apply the patch from Review Board. It will attempt to install the package using pip, but if it lacks permission you will need to manually install it. Additionally, the order of your build steps matter, so this step should likely be the first build step so all later build steps see the correct source code.

5. Scroll down to the Post-build actions section. Here we can add the Publish build status to Review Board step by clicking Add post-build action and choosing it from the dropdown menu.

6. Click Save to save these changes.