Webhook to Jenkins configuration

Several steps are required to configure Jenkins to integrate with your Bitbucket repository.

• Configuring Jenkins using either the Classic UI or the Blue Ocean plugin

• Configuring Bitbucket:

  1. Globally - Administration (gear icon top right) > Jenkins instances

  2. Project or Repository hook settings

• Implementing General Settings or Advanced Configuration features depending on your development requirements.

To successfully use Webhook to Jenkins, the configuration process is made up of two parts:

• Your Jenkins instance

• Your Bitbucket project or repository

This document does not include detailed instructions regarding the initial setup of your Jenkins or Bitbucket instances. For more information regarding these topics, refer to Bitbucket and Jenkins documentation.

Before you begin

Before you begin configuring your Jenkins instance, confirm the following actions have been performed:

• Install either the Bitbucket Branch Source plugin or the Git plugin, depending on the option you and your organization use. Refer to the what plugin should I use page for more information.

• Install Webhook to Jenkins.

• Add a new instance to Jenkins in Bitbucket.

Add a new instance of Jenkins in Bitbucket

Adding an instance of Jenkins in Bitbucket makes configuring project-level and repository-level easier by allowing Webhook to Jenkins to use the entered Jenkins instance location as the default URL.

Global level

1. Log into your Bitbucket instance as an Administrator.

2. Click the Administration icon in the top right corner to open the Administration page.

3. Under ADD-ONS, click Jenkins Servers.

   Open

   

4. Click Add New Instance.

5. Enter the Jenkins instance URL in the Jenkins Base field, your Jenkins Username and Password, and if you are using Git plugin version 4.11.4 or higher, the notifyCommit access token. See Access token requirements for Git plugin 4.11.4+ for information on how to generate the token. When using an earlier version of the Git plugin, the notifyCommit token is not required.

   Open

   

6. Click Save Instance.

You can also access this page through Bitbucket Administration (Administration > Manage Apps > Webhook to Jenkins for Bitbucket > Configure).

Project level

A new Jenkins instance can also be created at the Project level by Admins that have this level of access.

1. Confirm you are logged into Bitbucket as an Administrator.

2. Select the project you want to associate with Jenkins.

3. Click Project Settings from the left sidebar.

4. Click Webhook to Jenkins for Bitbucket under the ADD-ONS heading. The Webhook to Jenkins for Bitbucket page opens.

To add a new Jenkins instance:

1. Select the Scope (Global, Project) from the dropdown list.

2. Click Add New Instance.

3. Enter the Jenkins instance URL in the Jenkins Base field, your Jenkins Username and Password, and if you are using Git plugin version 4.11.4 or higher, the notifyCommit access token. See Access token requirements for Git plugin 4.11.4+ on how to generate the token. When using an earlier version of the Git plugin, the notifyCommit token is not required.

Click Save instance. A successful entry appears in the Jenkins instance list.

From this page you can also:

• View the current Hook status

• Access Hook Settings (See Bitbucket Configuration for more information)

• Access Documentation

• Contact Support

Repository level

A new Jenkins instance can also be created at the Repository level by Administrators that have this level of access.

1. Confirm you are logged into Bitbucket as an Administrator.

2. Select the project you want to associate with Jenkins.

3. Click Repository Settings from the left sidebar.

4. Click Webhook to Jenkins for Bitbucket under the ADD-ONS heading. The Webhook to Jenkins for Bitbucket page opens.

To add a new Jenkins instance:

1. Select the Scope (Global, Project) from the dropdown list.

2. Click Add New Instance.

3. Enter the Jenkins instance URL in the Jenkins Base field, your Jenkins Username and Password, and if you are using Git plugin version 4.11.4 or higher, the notifyCommit access token. See Access token requirements for Git plugin 4.11.4+ on how to generate the token. When using an earlier version of the Git plugin, the notifyCommit token is not required.

4. Click Save instance. A successful entry appears in the Jenkins instance list.

From this page you can also:

• View the current Hook status

• Access Hook Settings (See Bitbucket Configuration for more information)

• Access Documentation

• Contact Support

When configuring Webhook to Jenkins at both the project and repository levels, the Jenkins instance URL is the default entry in the URL field.

Proceed to the Jenkins configuration or Bitbucket configuration sections.