From be96465271012b86010b9dee04abea8585dc177c Mon Sep 17 00:00:00 2001
From: Craig Jennings <c@cjennings.net>
Date: Tue, 5 May 2026 10:15:00 -0500
Subject: ci: add GitHub Actions workflow with test matrix, lint, and coverage

Three jobs:

- test: matrix across Emacs 28.2 / 29.4 / snapshot.  Sets up Emacs
  via jcs090218/setup-emacs and Cask via cask/setup-cask, then
  runs make setup (with 3 retries to absorb MELPA flakes) and
  make test-unit.  Org 9.6 ships built-in with Emacs 29; on 28
  Cask pulls it from MELPA per our depends-on declaration.
- lint: Emacs 29.4 only, runs make lint (informational), then
  make compile and make validate-parens.
- coverage: same Emacs version, runs make coverage, prints a
  per-file summary via scripts/coverage-summary.py (copied from
  emacs-wttrin), uploads .coverage/simplecov.json as a workflow
  artifact, and sends results to Coveralls via continue-on-error
  so CI doesn't fail when COVERALLS_REPO_TOKEN isn't set yet.

The README badge URL points at this workflow file (ci.yml) so it
auto-populates on the next push to main.

Closes the [#B] GitHub Actions TODO.  After this lands, the
remaining setup is enabling the org-drill repo on coveralls.io
and adding COVERALLS_REPO_TOKEN as a GitHub secret so the
upload step actually publishes.
---
 scripts/coverage-summary.py | 56 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100755 scripts/coverage-summary.py

(limited to 'scripts')

diff --git a/scripts/coverage-summary.py b/scripts/coverage-summary.py
new file mode 100755
index 0000000..9b7bc99
--- /dev/null
+++ b/scripts/coverage-summary.py
@@ -0,0 +1,56 @@
+#!/usr/bin/env python3
+"""Print a per-file and overall coverage summary from undercover's simplecov JSON.
+
+Usage:
+    python3 scripts/coverage-summary.py [path]
+
+If `path` is omitted, defaults to `.coverage/simplecov.json`.
+Exit code is 0 on success, 1 if the JSON is missing or malformed.
+"""
+
+import json
+import os
+import sys
+
+
+def main(path: str) -> int:
+    try:
+        with open(path) as f:
+            data = json.load(f)
+    except FileNotFoundError:
+        print(f"error: {path} not found; run `make coverage` first", file=sys.stderr)
+        return 1
+    except json.JSONDecodeError as exc:
+        print(f"error: {path} is not valid JSON: {exc}", file=sys.stderr)
+        return 1
+
+    try:
+        suite = data["undercover.el"]["coverage"]
+    except (KeyError, TypeError):
+        print(f"error: {path} does not look like an undercover simplecov report",
+              file=sys.stderr)
+        return 1
+
+    print(f'{"File":<30} {"Lines":>7} {"Covered":>8} {"Coverage":>10}')
+    print("-" * 60)
+
+    total_lines = 0
+    total_covered = 0
+    for fname, lines in suite.items():
+        relevant = [l for l in lines if l is not None]
+        covered = sum(1 for l in relevant if l > 0)
+        pct = 100.0 * covered / len(relevant) if relevant else 0.0
+        total_lines += len(relevant)
+        total_covered += covered
+        short = os.path.basename(fname)
+        print(f"{short:<30} {len(relevant):>7} {covered:>8} {pct:>9.2f}%")
+
+    print("-" * 60)
+    overall = 100.0 * total_covered / total_lines if total_lines else 0.0
+    print(f'{"TOTAL":<30} {total_lines:>7} {total_covered:>8} {overall:>9.2f}%')
+    return 0
+
+
+if __name__ == "__main__":
+    target = sys.argv[1] if len(sys.argv) > 1 else ".coverage/simplecov.json"
+    sys.exit(main(target))
-- 
cgit v1.2.3