Project Badges

Project badges let you display your test suite’s health status in your README, wiki, or any other page that supports images. Badges are powered by Shields.io and update automatically as new test results come in.

The badge reflects the Aggregated Status of your latest test results.

Setup

Badges are managed in Project Settings by project editors.

1. Go to your project’s Settings page
2. Click Generate Badge
3. Copy the Markdown snippet or the Image URL

The Markdown snippet looks like:

[![Tests](https://img.shields.io/endpoint?url=...)](https://flakiness.io/org/project)

Paste it into your README.md and the badge will render automatically.

Regenerating & Deleting

• Regenerate — creates a new badge token, invalidating the old URL. Use this if the badge URL has been leaked or you want to reset it.
• Delete — removes the badge entirely. The old URL will stop working.

Both actions are available in Project Settings.