IBM Cloud Docs
Publishing a build record

Publishing a build record

You can publish a build record by using other continuous integration and continuous delivery (CI/CD) tools with the IBM Cloud command line interface (CLI) to integrate with IBM Cloud® DevOps Insights. Build records notify DevOps Insights when a build is complete. This record contains the application name, branch, build ID, reference to Git repo, and other fields. You must publish build records to view any test records, deployment records, or evaluate policies in DevOps Insights.

Before you begin

Before you publish a build record, you must set consistent parameter values. For more information, see Setting consistent parameter values by using other CI/CD tools.

Publishing a build record with other CI/CD tools

In a build job, use the following script to upload a build record. Use the buildrecord-publish command to upload a build record.

#!/bin/bash

#install the latest version of DevOps Insights plugin
ibmcloud plugin install -f doi

# Log in to IBM Cloud if you are not already logged in.  Assumes that $API_KEY environment variable has been set
ibmcloud login --apikey $API_KEY --no-region

# Please set variable $GIT_BRANCH, $GIT_URL and $GIT_COMMIT for better build record data
# Assumes you have set $MY_APP_NAME and $MY_BUILD_NUMBER as described earlier

ibmcloud doi buildrecord-publish --logicalappname="$MY_APP_NAME" --buildnumber="$MY_BUILD_NUMBER" --branch $GIT_BRANCH --repositoryurl $GIT_URL --commitid $GIT_COMMIT --status pass

The status field takes the pass or fail values.

Viewing Build Frequency

When this build job completes, your CI/CD tool publishes a message to DevOps Insights that a build is complete. You can view the build record on the Build Frequency page. To view the Build Frequency page, use the following steps.

  1. From the IBM Cloud console, click the Menu icon hamburger icon > Platform Automation > Toolchains.
  2. Select your toolchain.
  3. From your toolchain's Overview page, on the IBM Cloud tools card, click DevOps Insights.
  4. Click Build Frequency.

Next steps

Publish a deployment record by using other CI/CD tools.