Adding Build Badges

JFrog Pipelines Documentation
Products
JFrog Pipelines
Content Type
User Guide
ft:sourceType
Paligo

Build badges enable you to display the current status of your pipeline in your repository. This is useful for instantly showcasing your build statuses and promoting transparency within your team.

While a build badge can be added to your readme.md file, it can also be added to any web page.

buildBadge_17jul23.png

Note

Click here to see an example of a build badge being used in a readme.

To add a build badge, add the following:

Run-level Build Badge

  • Single Branch Source: https://{host_name}/pipelines/api/v1/badges/project/{project_key}/pipelines/{pipelines_name}?text=JFrogPipelines

    Example

    ![Approval Gates](https://pipelines.jfrog.io/pipelines/api/v1/badges/project/quickstarts/pipelines/Approval_Gates_Pipeline?text=JFrogPipelines)

  • Multi Branch Source: https://{host_name}/pipelines/api/v1/badges/project/{project_key}/pipelines/{pipelines_name}?branch={branch_name}&text=JFrogPipelines

Step-level Build Badge

http://{host_name}/pipelines/api/v1/badges/project/{project_key}/pipelines/{pipeline_name}/steps/{step_name}?text=JFrogPipelines

Example

![Approval Gates](https://pipelines.jfrog.io/pipelines/api/v1/badges/project/quickstarts/pipelines/Approval_Gates_Pipeline/steps/p1_s1?text=JFrogPipelines)