Enabling actionable build notifications in GitHub and Bitbucket

The CloudBees CI SCM Reporting feature is an integration that allows you to receive and act upon granular, actionable build and reporting data directly in GitHub or Bitbucket. You can see whether a build has passed or failed and, in the case of failure, quickly pinpoint the root cause.

This capability eliminates context switching and supports a workflow that is not only desirable for usability but also for auditability and reporting purposes with Git as the single source of truth.

CloudBees CI SCM Reporting feature benefits

The CloudBees CI SCM Reporting feature provides the following benefits:

  • Installs easily and does not require updates to Pipelines.

  • Provides rich information beyond the standard GitHub or Bitbucket pass/fail status including:

    • Build stages and steps.

    • Parallel branches so you can see which are in progress, which have errors, and which are finished.

  • Displays checks for code coverage and test results directly in GitHub or Bitbucket.

    • Picks up individual files for problematic lines of code.

    • Supports rich Markdown (copies of stack traces, test results or other information that can be picked up automatically from a Jenkins plugin, etc.).

  • Delivers detailed error and warning summaries. For example, for a failed shell command, CloudBees CI SCM Reporting provides the text of the shell command output.

Supported versions

The CloudBees SCM Reporting plugin is available on the following versions and platforms:

  • CloudBees CI on modern cloud platforms version 2.222.4.3 (and higher)

  • CloudBees CI on traditional platforms version 2.222.4.3 (and higher)

  • CloudBees Jenkins Platform version 2.222.4.3 (and higher)

Prerequisites

The following prerequisites are required before enabling CloudBees CI SCM Reporting:

  • Install the Bitbucket Branch Source plugin to your CloudBees CI instance if you will be using Bitbucket as your SCM.

  • Install the CloudBees SCM Reporting plugin to your CloudBees CI instance.

    The CloudBees SCM Reporting plugin adds to existing build data provided by the GitHub Branch Source plugin, which is installed by default on CloudBees CI installations.
The additional build data appears only for Multibranch Pipelines on GitHub or Bitbucket.

Installing the CloudBees SCM Reporting plugin

To install the CloudBees SCM Reporting plugin:

  1. From the CloudBees CI dashboard, select Manage Jenkins > Manage Plugins.

  2. Select the Available tab.

  3. Use the Filter field to search for CloudBees SCM Reporting plugin.

  4. Select the checkbox to choose the CloudBees SCM Reporting plugin.

  5. Select Download now and install after restart to install the plugin.

Enabling GitHub App authentication

You can create a GitHub App and switch your SCM source to use GitHub App authentication.

This has several benefits:

  • It is simpler and safer to use an app with limited permissions than a personal access token even from a bot account.

  • You get a request rate limit that grows with your GitHub organization size (users/repositories) limit.

  • CloudBees SCM Reporting plugin will automatically switch to using the Checks tab and offer much richer information.

There are two options for enabling GitHub App authentication:

  1. Use the GitHub App wizard.

  2. Manually create a GitHub App.

If you are only using the GitHub App authentication for a single organization then the GitHub App wizard option is the best choice. However, if you need to allow multiple organizations to use GitHub App authentication or have complex requirements and need a more customized approach, you should manually create the GitHub App.

If your SCM source is an organization, you must be an owner to create a GitHub App.

To enable GitHub App authentication using the GitHub App wizard:

  1. From the GitHub Organization in CloudBees CI, select Create GitHub App in the left navigation.

  2. Select Create App.

  3. Confirm your GitHub password, if requested.

  4. Edit the suggested GitHub App name in the text field if desired, and select Create GitHub App for <GitHub organization/user name>.

    The <GitHub organization/user name> will be the GitHub organization/user account where the GitHub App will be located.
  5. Select Install your new application under Next steps: to install your GitHub App.

    gh app created
  6. Select Install to confirm the installation location.

  7. Select either All repositories or Only select repositories for where you want to install the GitHub App.

  8. Select Install.

  9. [Optional] Select Upload a logo for your application to update the GitHub App profile with an appropriate icon to display with notifications.

    Adding an appropriate logo here will help users to understand the context of the notifications they see in the Checks tab of a pull request.
  10. Select branch source configuration to verify that GitHub App authentication has been applied to your CloudBees CI project, and Save to trigger a rescan using the new credentials.

    While on the GitHub Organization configuration page in CloudBees CI you can also update CloudBees SCM Reporting configuration options as described in Configuring CloudBees SCM Reporting notifications.
  11. [Optional] Select webhook delivery logs to verify the webhook the GitHub App wizard established is working as expected.

To enable GitHub App authentication by creating the GitHub App manually, follow the instructions in Using GitHub App authentication.

After enabling CloudBees SCM Reporting, users can configure notifications.