Documentation

Nix Flakes Garn yaml config What Garnix CI does Deployments Using Private Inputs Caching GitHub Actions Integration Badges

Badges

Garnix can display a badge on your README (or anywhere else) that shows its current build status. Like this: .

Note: Badges do not work with private repos.

Here's a little helper that generates the badge for a given repository and, optionally, branch. It also produces snippets in various document formats that can be copied verbatim wherever you want it to appear.

Repository:Branch:badge:

URL:

https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fgarnix.io%2Fapi%2Fbadges%2Fgarnix-io%2Fhello-garnix

Markdown:

[![built with garnix](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fgarnix.io%2Fapi%2Fbadges%2Fgarnix-io%2Fhello-garnix)](https://garnix.io)

HTML:

<a href="https://garnix.io"><img alt="built with garnix" src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fgarnix.io%2Fapi%2Fbadges%2Fgarnix-io%2Fhello-garnix"></a>

Org:

#+ATTR_HTML: :alt built with garnix
[[https://garnix.io][https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fgarnix.io%2Fapi%2Fbadges%2Fgarnix-io%2Fhello-garnix]]

rSt:

.. image:: https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fgarnix.io%2Fapi%2Fbadges%2Fgarnix-io%2Fhello-garnix
   :alt: built with garnix
   :target :https://garnix.io

AsciiDoc:

image:https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fgarnix.io%2Fapi%2Fbadges%2Fgarnix-io%2Fhello-garnix[alt=built with garnix,link=https://garnix.io]