Badges

How to get your badge

The server has an endpoint that will return an SVG badge for the default branch of your repo. The badge represents the current status for the most recent build for that branch. The most recent build refers to any build produced by the repo that is attached to that branch, which includes any event (push, pull request, etc).

# Syntax
https://<vela server>/badge/<org>/<repo>/status.svg

# Example
https://vela.example.com/badge/octocat/Hello-World/status.svg

In addition you can specify which branch you want to get a badge for by supplying a ?branch= query parameter in the URL.

# Syntax
https://<vela server>/badge/<org>/<repo>/status.svg?branch=<branch name>

# Example
https://vela.example.com/badge/octocat/Hello-World/status.svg?branch=not_default

Embedding in Markdown

To embed your badge in your markdown formatted file, follow this example:

# Syntax
[![Build Status](https://<vela server>/badge/<org>/<repo>/status.svg)](https://<vela server>/<org>/<repo>)

# Example
[![Build Status](https://vela.example.com/badge/octocat/Hello-World/status.svg)](https://vela.example.com/octocat/Hello-World)