Overview
CircleCI provides status badges that offer a visual representation of the build status, enabling easy tracking of the health and progress of your CI/CD pipeline in the UI (not when integrating with outside apps). These badges come in a few different types, each indicating a specific aspect of the build status. Here's a comprehensive guide to understanding the different status badges in CircleCI builds:
Build/Job Status Badge
Badge URL Format:
https://circleci.com/gh/<ORG>/<PROJECT>/tree/<BRANCH>.svg?style=svg&circle-token=<TOKEN>
Indication: Reflects the overall status of the latest build or job on the specified branch. Variants include:
Passing: Indicates that the build has completed successfully without any errors.
Failing: Signifies that the build has encountered errors or failures during the execution of tasks.
Running: Shows that the build is currently in progress and is actively being executed.
Canceled: Indicates that the workflow has been stopped or canceled due to outside intervention, such as an API call, manual user intervention, etc. This badge is denoted by a black color.
Not Run: While similar to the Canceled status badge in appearance, this status typically comes with an error or warning message in the UI stating that the build was not run for various reasons.
Approval Status Badge (approval)
Badge URL Format:
https://circleci.com/gh/<ORG>/<PROJECT>/<WORKFLOW_ID>/status?circle-token=<TOKEN>
Indication: Displays the approval status of a manual approval step within a workflow. Key points include:
Approved: Confirms that the manual approval step has been successfully authorized and allowed to progress further.
Pending Approval: Indicates that a manual approval is required before the workflow can continue execution.