mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2025-02-24 23:26:21 +00:00
bdf753f678
Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com> Co-authored-by: qwerty287 <qwerty287@posteo.de> Co-authored-by: Robert Kaussow <mail@thegeeklab.de> Co-authored-by: Anbraten <anton@ju60.de> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Anbraten <6918444+anbraten@users.noreply.github.com>
18 lines
739 B
Markdown
18 lines
739 B
Markdown
# 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
|
|
|
|
```uri
|
|
<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.
|
|
|
|
```diff
|
|
-<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.
|