mirrors/woodpecker
1
0
Fork 0
mirror of https://github.com/woodpecker-ci/woodpecker.git synced 2024-11-30 05:41:12 +00:00
Code Issues Projects Releases Wiki Activity
woodpecker/docs/versioned_docs/version-2.4/20-usage/80-badges.md
6543 385e7e3a49
Create docs for v2.4.x (#3507)
2024-03-19 08:36:20 +01:00

739 B
Raw Blame History

Status Badges

Woodpecker has integrated support for repository status badges. These badges can be added to your website or project readme file to display the status of your code.

Badge endpoint

<scheme>://<hostname>/api/badges/<repo-id>/status.svg

The status badge displays the status for the latest build to your default branch (e.g. main). You can customize the branch by adding the branch query parameter.

-<scheme>://<hostname>/api/badges/<repo-id>/status.svg
+<scheme>://<hostname>/api/badges/<repo-id>/status.svg?branch=<branch>

Please note status badges do not include pull request results, since the status of a pull request does not provide an accurate representation of your repository state.