Compliance Badges

Overview

GOVERN Build generates dynamic badges you can embed in your README to show the current governance status of your repository.

Available badges

Build status badge

Shows pass/fail for the latest build on your default branch:

![GOVERN Build](https://badges.govern.archetypal.ai/build/my-org/my-app/main)

Compliance score badge

Shows the average governance score across all tests:

![GOVERN Score](https://badges.govern.archetypal.ai/score/my-org/my-app/main)

Individual scorer badges

![Security](https://badges.govern.archetypal.ai/scorer/my-org/my-app/main/security)
![Bias](https://badges.govern.archetypal.ai/scorer/my-org/my-app/main/bias)
![Accuracy](https://badges.govern.archetypal.ai/scorer/my-org/my-app/main/accuracy)

Badge colors

State	Color
Passing	Cyan (`#00d4ff`)
Warning	Amber (`#ffa700`)
Failing	Red (`#ff5050`)
Unknown / no data	Gray

Badge URL parameters

Parameter	Description	Example
`branch`	Branch to show	`?branch=main`
`style`	Badge style	`?style=flat-square`
`label`	Override label text	`?label=AI+Governance`

https://badges.govern.archetypal.ai/build/my-org/my-app/main?style=flat-square&label=Governance

Complete README example

# My AI Application

[![GOVERN Build](https://badges.govern.archetypal.ai/build/my-org/my-app/main)](https://govern.archetypal.ai/repos/my-org/my-app)
[![Security](https://badges.govern.archetypal.ai/scorer/my-org/my-app/main/security)](https://govern.archetypal.ai/repos/my-org/my-app)
[![Bias](https://badges.govern.archetypal.ai/scorer/my-org/my-app/main/bias)](https://govern.archetypal.ai/repos/my-org/my-app)

An AI-powered application with continuous governance monitoring.

Setting up public badges

Badges are public by default for public repositories. For private repositories:

Go to GOVERN → Settings → Repositories → [your repo]
Toggle “Allow public badges”

Copy the badge URL with the embedded token:

https://badges.govern.archetypal.ai/build/my-org/my-app/main?token=badge_xxxx

The badge token is read-only and scoped to badge rendering only. It does not grant API access.

Badge caching

Badges are cached for 60 seconds. For time-sensitive compliance displays (compliance dashboards, audit reports), use the Build API to fetch live data instead.

Compliance certificate

For formal compliance reports, GOVERN generates a governance certificate — a signed PDF showing the governance history, test coverage, and current scores:

govern build certificate my-org/my-app --branch main --output compliance-cert.pdf

Certificates include:

Organization and repository details
Assessment history (last 90 days)
Current policy version and scores
Cryptographic signature (verifiable by auditors)
QR code linking to the live GOVERN report