Badges are used to display metric data and can distinguish whether metrics meet standards through different colors.

Cloud Native Build Related Badges

Badge Access Path

Badges generated during cloud native builds can be accessed via:

• precise: https://cnb.cool/{group}/{repository}/-/badge/git/{sha}/{metrics}

• latest: https://cnb.cool/{group}/{repository}/-/badge/git/latest/{metrics}

• branch latest: https://cnb.cool/{group}/{repository}/-/badge/git/latest/{metrics}?branch={branch}

• Parameter meanings:

  • group: The repository's group
  • repository: Repository name
  • sha: First 8 characters of the CommitId
  • latest: When the branch parameter is not specified, fetch the badge for the latest commit on the default branch; when the branch parameter is specified, fetch the badge corresponding to the latest commit hash of the specified branch.
  • metrics: Metric name, e.g., ci/status/push, which represents: build time triggered by push event during cloud native build
  • branch: The branch name, such as main, takes effect only when the SHA is set to latest. In this case, the badge corresponding to the latest commit hash of the current branch will be fetched.

Badge Types

During cloud native builds, badge data for relevant build metrics will be automatically uploaded:

1. Git Events

• ci/status/push

Push event build time and build status

• ci/status/commit.add

Push event build time and build status

• ci/status/branch.create

Branch create event build time and build status

• ci/status/pull_request

Pull request event build time and build status

• ci/status/pull_request.update

Pull request update event build time and build status

• ci/status/pull_request.target

Pull request target event build time and build status

• ci/status/pull_request.merged

Pull request merged event build time and build status

• ci/status/tag_push

Tag push event build time and build status

2. Workspace Preparation

• ci/git-clone-yyds

Workspace size and preparation time:

3. Pipeline Configuration

• ci/pipeline-as-code

Cloud native build configuration file:

4. Cloud Native Development

• code/vscode-started

Development environment preparation time:

5. Unit Testing

Using the built-in task testing:coverage can report unit test badge data

• testing/unit/coverage

Total unit test coverage

• testing/unit/coverage-pr

Incremental unit test coverage for this pull request

6. Security

• security/tca

Tencent cloud code analysis(TCA)：

7. Crontab Status

• ci/status/crontab

Crontab build duration and build status

Repository Related Badges

Fork Badge

Display repository fork count in badge form:

Access path: https://cnb.cool/{group}/{repository}/-/badge/fork

Parameter meanings:

• group: Repository organization path
• repository: Repository name

Star Badge

Display repository star count in badge form:

Access path: https://cnb.cool/{group}/{repository}/-/badge/star

Parameter meanings:

• group: Repository organization path
• repository: Repository name

Deploy Badge

Display the latest deployment status and version of a repository environment in badge form:

• With successful deployment:
• Without deployment record:

Access path: https://cnb.cool/{group}/{repository}/-/badge/deploy?name={name}

Click-through path: https://cnb.cool/{group}/{repository}/-/badge/deploy.link?name={name}

Parameter meanings:

• group: Repository organization path
• repository: Repository name
• name: Deployment environment name (required), e.g., production, staging, etc.

Release Badge

Display the latest Release version of a repository in badge form. If a Release tag has been manually set as the Latest Release, the badge will prioritize displaying that manually set Release; otherwise, it defaults to the most recently created Release:

• With Release:
• Without Release:

Access path: https://cnb.cool/{group}/{repository}/-/badge/release

Click-through path: https://cnb.cool/{group}/{repository}/-/badge/release.link

Parameter meanings:

• group: Repository organization path
• repository: Repository name

Using Badges in Markdown

The following two formats are supported for using badges as images in markdown:

With domain and repository: ![Full path badge](https://cnb.cool/groupname/reponame/-/badge/git/latest/ci/git-clone-yyds)

Without domain and repository: paths starting with /-/badge/git will be recognized as badges: ![Relative path badge](/-/badge/git/latest/ci/git-clone-yyds)

Next pageOpenAPI