Zum Inhalt springen

CI-Geschwindigkeits-Badge in Ihre README einfügen

Zuletzt aktualisiert am

Ein CI-Speed-Badge zeigt direkt in Ihrer README die mediane Laufzeit der letzten GitHub Actions-Läufe Ihres Repositorys. Mitwirkende sehen auf einen Blick, wie lange sie auf die Checks warten müssen, und eine niedrige Zahl signalisiert ganz unaufdringlich, dass das Projekt gut gepflegt wird. Diese Seite zeigt, wie Sie ein solches Badge hinzufügen, was die Zahl bedeutet und welche Datenschutzregeln dahinterstehen.

Der Badge

Für ein Repository, dessen CI auf compiler.dev läuft, fügen Sie diese Zeile in README.md ein und ersetzen OWNER/REPO:

[![CI speed](https://compiler.dev/badge/OWNER/REPO.svg)](https://compiler.dev/benchmarks)

Er wird als kleines Badge dargestellt, etwa CI | 2m 14s · compiler.dev. GitHub zwischenspeichert README-Bilder über seinen Camo-Proxy; der Badge erlaubt eine Zwischenspeicherung von 10 Minuten, sodass die Zahl Ihren Runs eng folgt.

Was die Zahl bedeutet

Die Zeit ist der Median Ihrer letzten 20 Workflow-Runs der vergangenen 30 Tage, gemessen vom Einreihen des ersten Jobs bis zum Abschluss des letzten Jobs. Das ist die Zeit, die Mitwirkende tatsächlich warten, einschließlich Wartezeit in der Warteschlange, und nicht die Summe der Jobminuten. Nur Runs, deren Jobs vollständig auf compiler.dev-Maschinen liefen, werden gezählt, sodass ein Run, der auf Ihre eigenen Runner ausgewichen ist, die Zahl nicht verfälscht.

Der Median wird statt des Durchschnitts verwendet, damit ein hängender oder abgebrochener Run den Badge nicht springen lassen kann.

Datenschutz

Der Badge zeigt nur für öffentliche Repositorys eine Zeit an. Bevor eine Zahl angezeigt wird, prüft compiler.dev die öffentliche API von GitHub; bei einem privaten Repository oder einem, das GitHub nicht kennt, steht auf dem Badge nur „powered by compiler.dev“. Die Badge-URL eines privaten Repositorys irgendwo öffentlich einzubinden verrät also nichts über das Repository, nicht einmal, ob es compiler.dev nutzt.

Noch nicht auf compiler.dev?

Der Badge benötigt Laufzeiten, die compiler.dev für die von ihm ausgeführten Jobs erfasst. Ihre CI können Sie aber schon heute mit der kostenlosen Action CI Timing Report messen, die jeder Run-Zusammenfassung eine Zeittabelle pro Job hinzufügt. Um die Zahl zu senken, beginnen Sie mit wie Sie GitHub Actions beschleunigen und dem Rechner für Testshards.

FAQ

Warum zeigt mein Badge „powered by compiler.dev“ statt einer Zeit an?

Entweder ist das Repository privat, es gab in den letzten 30 Tagen keine abgeschlossenen Runs auf compiler.dev, oder die API von GitHub war nicht erreichbar. Prüfen Sie, ob Besitzer und Repository-Name in der URL exakt so geschrieben sind wie auf GitHub.

Wie oft aktualisiert sich der Badge?

Die Laufzeiten werden höchstens alle 10 Minuten neu berechnet, und der Badge erlaubt GitHub, ihn 10 Minuten zwischenzuspeichern. Neue Runs erscheinen daher innerhalb von etwa 20 Minuten.

Kann ich den Badge nur für einen einzelnen Workflow verwenden?

Noch nicht. Der Badge umfasst alle Workflow-Runs des Repositorys, die auf compiler.dev liefen. Wenn Sie Zahlen pro Workflow benötigen, zeigt die Action CI Timing Report sie in jeder Run-Zusammenfassung an.

Diesen Workflow auf compiler.dev ausführen Keine Karte nötig · 200 kostenlose Minuten

Kostenlos testen