chore: replace coverage badge with job summary and commit status

jetersen · jetersen · commit 8a1e7e786789 · 2026-04-09T17:45:26.000+02:00
Remove the committed SVG badge in favor of a GitHub Actions job
summary and commit status check, eliminating merge conflicts on PRs.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -8,6 +8,7 @@ on:
 
 permissions:
   contents: read
+  statuses: write
 
 jobs:
   check-pr-labels:
@@ -70,3 +71,23 @@ jobs:
 
       - name: Check for clean working directory
         run: npm run check:clean
+
+      - name: Generate coverage summary
+        id: coverage
+        run: |
+          COVERAGE=$(npx tsx src/scripts/coverage-summary.ts)
+          echo "pct=$COVERAGE" >> "$GITHUB_OUTPUT"
+
+      - name: Set coverage status
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const pct = '${{ steps.coverage.outputs.pct }}';
+            await github.rest.repos.createCommitStatus({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              sha: context.sha,
+              state: 'success',
+              description: `${pct}%`,
+              context: 'Coverage',
+            });
diff --git a/README.md b/README.md
@@ -6,7 +6,6 @@
 
 ![CI](https://github.com/release-drafter/release-drafter/actions/workflows/ci.yml/badge.svg)
 ![CodeQL](https://github.com/release-drafter/release-drafter/actions/workflows/codeql-analysis.yml/badge.svg)
-![Coverage](./badges/coverage.svg)
 
 ## Usage
 
diff --git a/badges/coverage.svg b/badges/coverage.svg
diff --git a/package.json b/package.json
@@ -27,15 +27,15 @@
     "build": "vite build",
     "test": "vitest",
     "test:run": "vitest run",
-    "coverage": "npx tsx src/scripts/generate-coverage-badge.ts",
+    "coverage": "npx tsx src/scripts/coverage-summary.ts",
     "tsc:check": "tsc --noEmit && tsc --noEmit -p tsconfig.test.json",
     "format:write": "biome format --write .",
     "format:check": "biome format .",
     "lint": "biome lint .",
     "check": "biome check --write .",
     "codegen": "graphql-codegen -c src/scripts/graphql.codegen-config.ts -v",
     "schemas": "npx tsx src/scripts/json-schema.ts",
-    "all": "npm run check && npm run tsc:check && npm run test:run && npm run coverage && npm run schemas && npm run build",
+    "all": "npm run check && npm run tsc:check && npm run test:run && npm run schemas && npm run build",
     "check:clean": "npx tsx src/scripts/check-clean.ts",
     "preversion": "npm run all && npm run check:clean",
     "version": "git add package.json package-lock.json",
diff --git a/src/scripts/coverage-summary.ts b/src/scripts/coverage-summary.ts
@@ -0,0 +1,53 @@
+import { appendFileSync, readFileSync } from 'node:fs'
+import { resolve } from 'node:path'
+
+type CoverageSummary = {
+  total?: {
+    statements?: { pct?: number; total?: number; covered?: number }
+    branches?: { pct?: number; total?: number; covered?: number }
+    functions?: { pct?: number; total?: number; covered?: number }
+    lines?: { pct?: number; total?: number; covered?: number }
+  }
+}
+
+const coverageSummaryPath = resolve(
+  import.meta.dirname,
+  '../..',
+  'coverage',
+  'coverage-summary.json',
+)
+
+const coverageSummaryContent = readFileSync(coverageSummaryPath, {
+  encoding: 'utf-8',
+})
+const coverageSummary = JSON.parse(coverageSummaryContent) as CoverageSummary
+
+const total = coverageSummary.total
+if (!total?.statements?.pct && total?.statements?.pct !== 0) {
+  throw new Error('Unable to read coverage data from coverage-summary.json')
+}
+
+const pct = total.statements.pct
+
+// Print coverage percentage for CI to capture
+console.log(pct.toFixed(2))
+
+// Write GitHub Actions job summary if running in CI
+const summaryFile = process.env.GITHUB_STEP_SUMMARY
+if (summaryFile) {
+  const emoji = pct >= 90 ? '🟢' : pct >= 80 ? '🟡' : pct >= 70 ? '🟠' : '🔴'
+
+  const summary = [
+    `## ${emoji} Code Coverage: ${pct.toFixed(2)}%`,
+    '',
+    '| Metric | Coverage | Covered | Total |',
+    '| --- | --- | --- | --- |',
+    `| Statements | ${total.statements.pct?.toFixed(2)}% | ${total.statements.covered} | ${total.statements.total} |`,
+    `| Branches | ${total.branches?.pct?.toFixed(2)}% | ${total.branches?.covered} | ${total.branches?.total} |`,
+    `| Functions | ${total.functions?.pct?.toFixed(2)}% | ${total.functions?.covered} | ${total.functions?.total} |`,
+    `| Lines | ${total.lines?.pct?.toFixed(2)}% | ${total.lines?.covered} | ${total.lines?.total} |`,
+    '',
+  ].join('\n')
+
+  appendFileSync(summaryFile, summary)
+}
diff --git a/src/scripts/generate-coverage-badge.ts b/src/scripts/generate-coverage-badge.ts
