Skip to content

Badge Setup

Certify generates a shields.io endpoint badge that reflects your current certification status. It updates automatically when CI commits new results.

Terminal window
certify report --badge

This prints the markdown snippet for your README:

[![Certification](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/OWNER/REPO/main/.certification/badge.json)](https://github.com/OWNER/REPO/blob/main/.certification/REPORT_CARD.md)
  1. Every certify report run generates .certification/badge.json
  2. The JSON follows the shields.io endpoint schema
  3. shields.io reads the JSON from your repo’s raw content URL
  4. The badge renders with your current grade, pass rate, and unit count

Colors map to certification status per the brand guide:

GradeColorStatus
AGreen (#2E8B57)🟢 Certified
A-Green (#3DA06A)🟢 Certified
B+, BSteel Blue (#4A6B82)🟢 Certified
CAmber (#E0A100)🟡 Observations
DWarning (#F59E0B)🟠 Probationary
FRed (#DC2626)🔴 Decertified
{
"schemaVersion": 1,
"label": "certification",
"message": "B+ · 100% · 476 units",
"color": "4A6B82",
"namedLogo": "checkmarx",
"logoColor": "white"
}

The badge updates when .certification/badge.json changes in your repository. With the CI workflows from certify init, this happens automatically on every push to main.

Click the badge in any README → opens your full report card.