badges / shields

Concise, consistent, and legible badges in SVG and raster format
https://shields.io
Creative Commons Zero v1.0 Universal
23.38k stars 5.49k forks source link

Buildkite badges #10369

Open MichaelHinrichs opened 1 month ago

MichaelHinrichs commented 1 month ago

📋 Description

For Buildkite. Static Badge Static Badge Static Badge Static Badge Static Badge Static Badge Static Badge Static Badge Static Badge Static Badge Static Badge Static Badge

🔗 Data

https://buildkite.com/docs/apis/rest-api/annotations https://buildkite.com/docs/apis/rest-api/annotations#create-an-annotation-on-a-build https://buildkite.com/docs/pipelines/notifications#build-states https://buildkite.com/docs/apis/rest-api/pipeline-templates https://buildkite.com/docs/apis/agent-api/metrics#get-metrics

🎤 Motivation

Add dynamic badges for not yet implemented buildkite API data.

chris48s commented 1 month ago

Our existing BuildKite badge uses an unauthenticated and non-rate limited endpoint which just exposes one value

example call: https://badge.buildkite.com/3826789cf8890b426057e6fe1c4e683bdf04fa24d498885489.json

Moving to using the Rest API would require auth and also requires staying under a rate limit (200 requests per minute).

I suspect this one may also not be viable, but I think if someone is interested in working on this one, the first question to look into would be what data public data is available via the rest API. Does being an authenticated user allow access to any public metrics about all projects?

If not, do any of the documented scopes expose a small enough subset of data that they could be exposed in a badge URL? This probably need some input from someone who is at least a regular user of the BuildKite platform.