Status Badges

RWX can generate status badges for your runs, to be embedded on GitHub, GitLab, and anywhere else you'd like to embed an svg representing the current status of your runs.

You can preview badges and get copyable markdown for them in your organization settings.

Example markdown will look like this:

![build](https://cloud.rwx.com/status_badges/rwx.svg?branch=main&definition=.rwx%2Fmain.yml&repo=rwx)

All badges require the following query params:

  • repo - the repository name (no org prefix)
  • branch - the branch name
  • definition - the definition path (e.g. .rwx/ci.yml)

You can also set a label query param to override the default label of "build".

Private repositories

If a repository is not public, the badge will not show a status unless you also provide a token query param. You can click "Manage tokens" on the status badges page to create a token, and then will be able to select it when using the badge preview.

Multiple tokens can be created, in case you need to rotate them. These tokens are only used for authenticating status badges, and a leaked status badge token does not authorize access to your repository or other RWX features.