Setting up actionable build notifications in Microsoft Teams

CloudBees Microsoft Teams Integration is a Preview feature.
Preview

A Preview feature:

  • Has not undergone end-to-end testing with CloudBees products

  • Is provided without service-level agreements (SLA) and therefore does not include CloudBees' commitment on functionality or performance

  • May impact other stable areas of the product when used

  • May have limited documentation

  • May not be feature complete during the Preview period

  • May graduate from preview state to fully supported or be removed from the product

  • May introduce incompatible, backward-breaking changes that could revoke the ability to upgrade

Product features and documentation are frequently updated. If you find an issue or have a suggestion, please contact CloudBees Support.

CloudBees Microsoft Teams Integration sends Microsoft Teams messages to a specified channel to notify users of relevant status information and build data at the end of the sequence, so that they know if the build was successful, and if not, the actions that need to be taken to get a failed build back on track. The notifications include information on build and test results, including direct links to results and error details.

Sending messages to Microsoft Teams means that you do not need to switch between different tools to be alerted when builds complete, and in the case of failed builds you can take immediate action.

CloudBees Microsoft Teams Integration feature benefits

The CloudBees Microsoft Teams Integration feature provides the following benefits:

  • Provides feedback immediately upon completion of a build.

  • Highlights the causes of build failures quickly.

  • Limits context switching between tools.

  • Installs easily and does not require updates to Pipelines.

This feature does not require any modifications to Pipelines.
CloudBees CI Microsoft Teams Integration messages are only sent for commits that have a name associated with them. For example, for GitHub, Microsoft Teams Integration messages are only sent for Pull Requests - you will not get a failure notification on a branch.

The process of setting up actionable build notifications in Microsoft Teams requires an Administrator to Install the CloudBees Microsoft Teams Integration plugin on the controller in CloudBees CI, and either the Administrator or the user to Set up a custom incoming webhook in Microsoft Teams.

Supported versions

The CloudBees Microsoft Teams Integration plugin is available on the following versions and platforms:

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

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

  • CloudBees Jenkins Platform version 2.235.2.3 (and higher)

Setting up a custom incoming webhook in Microsoft Teams

The following set of instructions includes a reference implementation of Microsoft Teams Version 1.3.00.15561. Your experience with Microsoft Teams may vary depending on the version you are currently using. For more information from Microsoft documentation, see Setting up a custom incoming webhook.

To set up a custom incoming webhook in Microsoft Teams:

  1. In Microsoft Teams, select …​ next to the channel name.

  2. Select Connectors.

  3. Select Incoming Webhook.

  4. Select Configure.

  5. Enter a name for the webhook.

  6. Upload an image to associate data from the webhook.

  7. Select Create.

  8. Copy the webhook.

    You will need the webhook URL for Configuring Microsoft Teams notifications.
  9. Select Done.

Installing the CloudBees Microsoft Teams Integration Plugin

Admin privileges are needed to install the CloudBees Microsoft Teams Integration plugin.

The current Preview version of the CloudBees Microsoft Teams Integration plugin is not available to download and requires manual installation of the .hpi file.

To install the CloudBees Microsoft Teams Integration plugin .hpi file manually:
  1. From your CloudBees CI controller, navigate to Manage Jenkins > Manage Plugins > Advanced.

  2. Under Upload Plugin, select Choose File and select the CloudBees Microsoft Teams Integration plugin .hpi file.

  3. Select Upload.

  4. Once the upload is finished, restart the controller.

After enabling CloudBees CI Microsoft Teams Messaging, you need to configure users so that they can start receiving messages.

The CloudBees Microsoft Teams Integration Plugin is greatly enhanced when it can gather information from other plugins including: