-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathbadges.html
More file actions
302 lines (264 loc) · 15.9 KB
/
badges.html
File metadata and controls
302 lines (264 loc) · 15.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>ReleaseRun Badge API — Live Version & EOL Badges for READMEs</title>
<meta name="description" content="Free, auto-updating badges for GitHub READMEs. Show real-time version status, end-of-life dates, CVE counts, and health scores for 300+ technologies.">
<link rel="canonical" href="https://releaserun.github.io/badges">
<style>
:root { --bg: #0d1117; --card: #161b22; --border: #30363d; --text: #e6edf3; --muted: #8b949e; --accent: #58a6ff; --green: #3fb950; --orange: #d29922; --red: #f85149; }
* { margin: 0; padding: 0; box-sizing: border-box; }
body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif; background: var(--bg); color: var(--text); line-height: 1.7; }
a { color: var(--accent); text-decoration: none; } a:hover { text-decoration: underline; }
.container { max-width: 860px; margin: 0 auto; padding: 0 24px; }
header { padding: 48px 0 32px; border-bottom: 1px solid var(--border); }
header h1 { font-size: 2em; margin-bottom: 8px; }
header h1 span { color: var(--accent); }
header p { color: var(--muted); font-size: 1.1em; max-width: 650px; }
nav.breadcrumb { margin-bottom: 16px; font-size: 0.9em; color: var(--muted); }
nav.breadcrumb a { color: var(--accent); }
section { padding: 36px 0; border-bottom: 1px solid var(--border); }
section:last-of-type { border-bottom: none; }
h2 { font-size: 1.5em; margin-bottom: 16px; }
h3 { font-size: 1.15em; margin: 20px 0 10px; color: var(--accent); }
p { margin-bottom: 12px; }
.badge-row { display: flex; align-items: center; gap: 12px; margin: 12px 0; flex-wrap: wrap; }
.badge-row img { height: 20px; }
code { background: rgba(110,118,129,0.2); padding: 2px 6px; border-radius: 4px; font-size: 0.9em; font-family: 'SF Mono', Consolas, monospace; }
pre { background: var(--card); border: 1px solid var(--border); border-radius: 8px; padding: 16px; overflow-x: auto; margin: 12px 0 20px; font-size: 0.85em; line-height: 1.5; }
pre code { background: none; padding: 0; }
.type-grid { display: grid; grid-template-columns: repeat(auto-fill, minmax(260px, 1fr)); gap: 16px; margin: 16px 0; }
.type-card { background: var(--card); border: 1px solid var(--border); border-radius: 8px; padding: 16px; }
.type-card h4 { font-size: 1em; margin-bottom: 6px; }
.type-card p { color: var(--muted); font-size: 0.85em; margin-bottom: 8px; }
table { width: 100%; border-collapse: collapse; margin: 12px 0; font-size: 0.9em; }
th, td { text-align: left; padding: 10px 12px; border-bottom: 1px solid var(--border); }
th { color: var(--muted); font-weight: 600; font-size: 0.85em; text-transform: uppercase; letter-spacing: 0.5px; }
.tag { display: inline-block; font-size: 0.75em; padding: 2px 8px; border-radius: 12px; }
.tag-free { background: rgba(63,185,80,0.15); color: var(--green); }
.note { background: rgba(88,166,255,0.1); border: 1px solid rgba(88,166,255,0.3); border-radius: 8px; padding: 14px 16px; margin: 16px 0; font-size: 0.9em; }
.note strong { color: var(--accent); }
.warn { background: rgba(210,153,34,0.1); border: 1px solid rgba(210,153,34,0.3); border-radius: 8px; padding: 14px 16px; margin: 16px 0; font-size: 0.9em; }
.warn strong { color: var(--orange); }
footer { padding: 32px 0; border-top: 1px solid var(--border); text-align: center; color: var(--muted); font-size: 0.85em; }
footer a { color: var(--accent); }
@media (max-width: 600px) { .type-grid { grid-template-columns: 1fr; } }
</style>
</head>
<body>
<header>
<div class="container">
<nav class="breadcrumb"><a href="https://releaserun.github.io">ReleaseRun</a> / Badge API</nav>
<h1>Badge <span>API</span></h1>
<p>Auto-updating SVG badges for GitHub READMEs, docs, and dashboards. Real-time data for 300+ technologies. Free, no signup, no API key.</p>
</div>
</header>
<section>
<div class="container">
<h2>Quick Start</h2>
<p>Drop a badge into any Markdown file. It updates automatically.</p>
<pre><code>
</code></pre>
<div class="badge-row">
<img src="https://img.releaserun.com/badge/eol/python.svg" alt="Python EOL badge">
<img src="https://img.releaserun.com/badge/v/nodejs.svg" alt="Node.js version badge">
<img src="https://img.releaserun.com/badge/health/kubernetes.svg" alt="Kubernetes health badge">
</div>
<h3>URL Format</h3>
<pre><code>https://img.releaserun.com/badge/{type}/{product}.svg
https://img.releaserun.com/badge/{type}/{product}/{version}.svg</code></pre>
<p>The <code>.svg</code> extension is required. All badges return SVG with proper CORS headers for embedding anywhere.</p>
<h3>Version-Specific Badges <span class="tag tag-free">NEW</span></h3>
<p>Pin badges to the exact version your project uses. Much more useful than generic "latest version" badges.</p>
<pre><code>
</code></pre>
<div class="badge-row">
<img src="https://img.releaserun.com/badge/health/nodejs/22.svg" alt="Node.js 22 health">
<img src="https://img.releaserun.com/badge/health/python/3.12.svg" alt="Python 3.12 health">
<img src="https://img.releaserun.com/badge/health/postgresql/16.svg" alt="PostgreSQL 16 health">
</div>
<p>Or generate them automatically with the CLI:</p>
<pre><code>npx releaserun badges # scan project, copy badge markdown to clipboard
npx releaserun readme --write # inject badges into your README automatically</code></pre>
</div>
</section>
<section>
<div class="container">
<h2>Badge Types</h2>
<div class="type-grid">
<div class="type-card">
<h4>🟢 Health</h4>
<p>Overall release health score based on version age, CVE count, and EOL proximity.</p>
<div class="badge-row"><img src="https://img.releaserun.com/badge/health/react.svg" alt="React health"></div>
<code>/badge/health/{product}.svg</code>
</div>
<div class="type-card">
<h4>📅 End of Life</h4>
<p>Shows EOL date and how long until support ends. Turns red when EOL is approaching.</p>
<div class="badge-row"><img src="https://img.releaserun.com/badge/eol/python.svg" alt="Python EOL"></div>
<code>/badge/eol/{product}.svg</code>
</div>
<div class="type-card">
<h4>🏷️ Version</h4>
<p>Latest stable version number. Updates automatically on new releases.</p>
<div class="badge-row"><img src="https://img.releaserun.com/badge/v/go.svg" alt="Go version"></div>
<code>/badge/v/{product}.svg</code>
</div>
<div class="type-card">
<h4>🛡️ CVE Count</h4>
<p>Known CVE count for the latest version. Color-coded by severity.</p>
<div class="badge-row"><img src="https://img.releaserun.com/badge/cve/docker-engine.svg" alt="Docker CVE"></div>
<code>/badge/cve/{product}.svg</code>
</div>
<div class="type-card">
<h4>☁️ Cloud</h4>
<p>Cloud provider support status for major platforms.</p>
<div class="badge-row"><img src="https://img.releaserun.com/badge/cloud/kubernetes.svg" alt="K8s cloud"></div>
<code>/badge/cloud/{product}.svg</code>
</div>
</div>
</div>
</section>
<section>
<div class="container">
<h2>Supported Technologies</h2>
<p>300+ products supported. Here are the most popular ones:</p>
<table>
<thead>
<tr><th>Product Slug</th><th>Technology</th><th>Types Available</th></tr>
</thead>
<tbody>
<tr><td><code>python</code></td><td>Python</td><td>health, eol, v, cve</td></tr>
<tr><td><code>kubernetes</code></td><td>Kubernetes</td><td>health, eol, v, cve, cloud</td></tr>
<tr><td><code>nodejs</code></td><td>Node.js</td><td>health, eol, v, cve</td></tr>
<tr><td><code>go</code></td><td>Go</td><td>health, eol, v, cve</td></tr>
<tr><td><code>rust</code></td><td>Rust</td><td>health, v</td></tr>
<tr><td><code>docker-engine</code></td><td>Docker Engine</td><td>health, eol, v, cve</td></tr>
<tr><td><code>react</code></td><td>React</td><td>health, v</td></tr>
<tr><td><code>postgresql</code></td><td>PostgreSQL</td><td>health, eol, v, cve</td></tr>
<tr><td><code>ruby</code></td><td>Ruby</td><td>health, eol, v, cve</td></tr>
<tr><td><code>php</code></td><td>PHP</td><td>health, eol, v, cve</td></tr>
<tr><td><code>dotnet</code></td><td>.NET</td><td>health, eol, v</td></tr>
<tr><td><code>terraform</code></td><td>Terraform</td><td>health, v</td></tr>
<tr><td><code>redis</code></td><td>Redis</td><td>health, eol, v</td></tr>
<tr><td><code>nginx</code></td><td>Nginx</td><td>health, eol, v</td></tr>
<tr><td><code>mysql</code></td><td>MySQL</td><td>health, eol, v, cve</td></tr>
<tr><td><code>mariadb</code></td><td>MariaDB</td><td>health, eol, v</td></tr>
<tr><td><code>java</code></td><td>Java (OpenJDK)</td><td>health, eol, v</td></tr>
<tr><td><code>typescript</code></td><td>TypeScript</td><td>health, v</td></tr>
<tr><td><code>angular</code></td><td>Angular</td><td>health, eol, v</td></tr>
<tr><td><code>vue</code></td><td>Vue.js</td><td>health, v</td></tr>
</tbody>
</table>
<p>For the full list of 300+ supported products, visit the <a href="https://releaserun.com/tools/badge-generator/">Badge Generator</a> tool.</p>
</div>
</section>
<section>
<div class="container">
<h2>Usage Examples</h2>
<h3>Version-Specific README (Recommended)</h3>
<pre><code># My Project
[](https://releaserun.com/nodejs/22/)
[](https://releaserun.com/python/3.12/)
[](https://releaserun.com/postgresql/16/)
Badges show health grades for the versions YOUR project actually uses.</code></pre>
<h3>Generic Badges</h3>
<pre><code># My Project
Show the latest stable version across the ecosystem.</code></pre>
<h3>HTML (Docs, Dashboards)</h3>
<pre><code><img src="https://img.releaserun.com/badge/eol/python.svg" alt="Python EOL status">
<img src="https://img.releaserun.com/badge/cve/kubernetes.svg" alt="Kubernetes CVE count"></code></pre>
<h3>reStructuredText (Sphinx Docs)</h3>
<pre><code>.. image:: https://img.releaserun.com/badge/v/python.svg
:alt: Python version
:target: https://releaserun.com/python/</code></pre>
<h3>AsciiDoc</h3>
<pre><code>image:https://img.releaserun.com/badge/health/kubernetes.svg[Kubernetes Health, link="https://releaserun.com/kubernetes/"]</code></pre>
<h3>Shields.io Style Combo</h3>
<p>Combine ReleaseRun badges with shields.io for a consistent look:</p>
<pre><code>[](...)
[](https://releaserun.com/python/)
[](LICENSE)</code></pre>
</div>
</section>
<section>
<div class="container">
<h2>Technical Details</h2>
<h3>Rate Limits</h3>
<p>2,000 requests per minute. Badges are cached server-side (TTL varies by type). No API key or signup needed.</p>
<h3>Response Format</h3>
<p>All badges return <code>image/svg+xml</code> with proper cache headers and CORS (<code>Access-Control-Allow-Origin: *</code>).</p>
<h3>Data Sources</h3>
<p>Version and EOL data from <a href="https://endoflife.date">endoflife.date</a> API, enriched with CVE data from NVD and cloud provider compatibility matrices.</p>
<h3>Uptime</h3>
<p>Badge service runs on dedicated infrastructure. Current uptime >99.9%.</p>
<div class="note">
<strong>Tip:</strong> Use badges with link targets to create clickable status indicators. Wrap the image in a link to the relevant <a href="https://releaserun.com">ReleaseRun</a> hub page for full release details.
</div>
</div>
</section>
<section>
<div class="container">
<h2>GitHub Action <span class="tag tag-free">v2</span></h2>
<p>Automate version checks in your CI pipeline with the <a href="https://github.com/Releaserun/releaserun-action">ReleaseRun GitHub Action</a>:</p>
<pre><code>- name: Check stack health
uses: Releaserun/releaserun-action@v2
with:
path: '.'
comment: 'true'
fail-on: 'F'</code></pre>
<p>v2 detects versions from your project files (package.json, Dockerfile, go.mod, requirements.txt, Cargo.toml, docker-compose.yml) and generates version-specific badge markdown in PR comments.</p>
<h3>Auto-Update README Badges</h3>
<pre><code>- name: Update README badges
uses: Releaserun/releaserun-action@v2
with:
path: '.'
update-readme: 'true'</code></pre>
<p>Automatically commits updated version-specific badges to your README on every PR.</p>
</div>
</section>
<section>
<div class="container">
<h2>CLI Tool <span class="tag tag-free">v1.4</span></h2>
<p>Scan any project directory and get version-specific badges instantly:</p>
<pre><code># Scan project and generate badge markdown
npx releaserun badges
# Inject badges into your README (between markers)
npx releaserun readme --write
# Full health check with grades
npx releaserun check</code></pre>
<p>The CLI reads package.json, Dockerfile, go.mod, requirements.txt, Cargo.toml, composer.json, Gemfile, pom.xml, docker-compose.yml, .nvmrc, .python-version, and .tool-versions to detect what your project actually uses.</p>
<p>Source: <a href="https://github.com/Releaserun/releaserun-cli">github.com/Releaserun/releaserun-cli</a> | <a href="https://www.npmjs.com/package/releaserun">npm</a></p>
</div>
</section>
<section>
<div class="container">
<h2>More Free Tools</h2>
<p>Badges are just one of 30+ free developer tools:</p>
<table>
<thead><tr><th>Tool</th><th>What It Does</th></tr></thead>
<tbody>
<tr><td><a href="https://releaserun.com/tools/dep-eol-scanner/">Dependency EOL Scanner</a></td><td>Paste package.json, requirements.txt, go.mod and get EOL status for every dependency</td></tr>
<tr><td><a href="https://releaserun.com/tools/vulnerability-scanner/">Vulnerability Scanner</a></td><td>Scan your stack for known CVEs with severity ratings</td></tr>
<tr><td><a href="https://releaserun.com/tools/k8s-deprecation-checker/">K8s Deprecation Checker</a></td><td>Paste a Kubernetes manifest and find deprecated APIs before upgrading</td></tr>
<tr><td><a href="https://releaserun.com/tools/dockerfile-linter/">Dockerfile Linter</a></td><td>Security and best-practice linting for Dockerfiles</td></tr>
<tr><td><a href="https://releaserun.com/tools/stack-health/">Stack Health Scorecard</a></td><td>Get a health score across your entire technology stack</td></tr>
</tbody>
</table>
<p><a href="https://releaserun.com/tools/">View all 30+ tools</a></p>
</div>
</section>
<footer>
<div class="container">
<p><a href="https://releaserun.github.io">ReleaseRun</a> · <a href="https://releaserun.com">releaserun.com</a> · <a href="https://github.com/Releaserun">GitHub</a></p>
<p style="margin-top: 8px;">Free and open. No signup required. No tracking.</p>
</div>
</footer>
</body>
</html>