Integrations

3 minute read

An integration in a CloudBees platform organization provides a standard interface connecting two or more systems. You can use integrations to facilitate communication and data exchange between different applications, resources, or services.

The following types of integrations are available:

  • Project management type

    • Jira

  • Source code management (SCM) types

    • Bitbucket access token

    • GitHub App

To complete integration setup or testing, the CloudBees platform may redirect you to your external provider.

Access an integration

Access the integrations that are key to connecting your repositories and project issues. To access an integration:

  1. Select the next to Configurations on the left pane, and then select Integrations.

  2. (Optional) Search for a specific integration, by entering all or part of an integration name into Search.

  3. (Optional) Select an option in Sort by to sort the integration list by either ASCENDING or DESCENDING alphanumerical sort order.

The integrations are displayed according to your search or sort criteria.

Create a project management integration

Create a project management integration to connect your Atlassian Jira tasks to the platform.

Create an Atlassian personal access token to set up the connection to your Jira account.

To create a Jira integration:

  1. Select the next to Configurations on the left pane, and then select Integrations.

  2. Select CREATE INTEGRATION.

  3. Select Project management.

  4. Select Jira.

  5. Enter a Name and an (optional) Description.

  6. Enter the URL.

  7. Enter the Username.

  8. Enter the Personal access token.

  9. Select SUBMIT.

The Jira integration is connected and listed in Integrations.

Jira integration
Figure 1. Setting up a Jira connection.

Create an SCM integration

Create an SCM integration to connect your repository. Connect to Bitbucket with an access token, or to GitHub by installing a GitHub App.

To create an SCM integration:

  1. Select the next to Configurations on the left pane, and then select Integrations.

  2. Select CREATE INTEGRATION.

  3. Select Source code management.

  4. Select one of the following options.

    • For Bitbucket access token:

      1. Enter a Name, an (optional) Description, and your Token.

        Create repository access token
        Figure 2. An example Bitbucket access token with the appropriate permissions.

        The CloudBees platform only requires the following scopes from Bitbucket:

        • Repositories: Read and write

        • Pull requests: Read and write

        • Webhooks: Read and write

      2. (Optional) Select TEST INTEGRATION.

      3. Select SUBMIT.

        Create environment
        Figure 3. Successfully connected Bitbucket integration, with TEST INTEGRATION highlighted.
    • For GitHub App:

      1. (Optional) Enter a Description.

      2. Select INSTALL GITHUB APP. This action redirects you to GitHub.

      3. Select a GitHub account or GitHub organization to connect.

        You only can set up a single platform integration with a given GitHub account or organization. GitHub accounts and organizations are displayed in GitHub as follows:

        • With a white background (no Configure): Available to connect to the platform.

        • With a light gray background and Configure: At least one repository is already connected to the platform.

        The integration name is automatically generated based on the GitHub organization name.

        Create environment
        Figure 4. GitHub App installation with available GitHub organization highlighted
      4. Install and authorize All repositories, or Only select repositories, and select from the options.

      5. Select Install & Authorize.

The integration is connected and listed in Integrations.

Update an integration

To connect a repository that is in a GitHub account or organization that is already connected, configure the connected repositories in GitHub.

From your CloudBees integration list, make updates to any integrations.

To update an integration:

  1. Select the next to Configurations on the left pane, and then select Integrations.

  2. Select the next to the integration you want to update.

  3. Select Edit integration.

  4. Make any desired changes.

  5. (Optional) Select TEST INTEGRATION.

  6. Select SAVE.

The selected integration is updated accordingly.

Delete an integration

Delete any of your integrations. A deleted integration is completely removed from the CloudBees platform, and deletion is irreversible.

To delete an integration:

  1. Select the next to Configurations on the left pane, and then select Integrations.

  2. Select the next to the integration you want to delete.

  3. Select Delete integration.

  4. Select DELETE.

The selected integration is deleted and removed from the integration list.