diff options
Diffstat (limited to 'doc/source/howtos/badges.rst')
| -rw-r--r-- | doc/source/howtos/badges.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/source/howtos/badges.rst b/doc/source/howtos/badges.rst index e6613dfc8..10ff36c1d 100644 --- a/doc/source/howtos/badges.rst +++ b/doc/source/howtos/badges.rst @@ -16,3 +16,10 @@ report, it is a simple static file: To use it, simply put ``https://zuul-ci.org/gated.svg`` into an RST or markdown formatted README file, or use it in an ``<img>`` tag in HTML. + +For advanced usage Zuul also supports generating dynamic badges via the +REST api. This can be useful if you want to display the status of e.g. periodic +pipelines of a project. To use it use an url like +``https://zuul.opendev.org/api/tenant/zuul/badge?project=zuul/zuul-website&pipeline=post`` +instead of the above mentioned url. It supports filtering by ``project``, +``pipeline`` and ``branch``. |