Skip to content

Show the test status per OS and memory model in the README - #77

Merged
ASDAlexander77 merged 2 commits into
mainfrom
readme-tests-badge
Nov 9, 2026
Merged

ASDAlexander77 merged 2 commits into
mainfrom
readme-tests-badge

Conversation

@ASDAlexander77

@ASDAlexander77 ASDAlexander77 commented Nov 9, 2026 •

Copy link
Copy Markdown
Owner

What changed

  • README: adds the overall Tests badge, and a table with one badge per OS (Windows, Ubuntu 24.04) and memory model (gc, rc, none, own). Each badge covers release and debug, compiled and under the JIT.
  • tests.yml: the test jobs record a result per model and upload it, even when a model fails. A new badges job turns the results into 8 shields.io endpoint files and force-pushes them to a badges branch, which holds only those files in a single commit.
  • tests.yml trigger: the tests now also run on pull requests into main, so problems show up before a merge. The badges job still runs only for pushes to main.

Why

GitHub's workflow badge only reports the workflow as a whole, so it can't show which OS or memory model failed.

Reviewer notes

  • Merging creates a new badges branch on the first run. The new job has contents: write for this; it uses the default GITHUB_TOKEN and needs no secrets.
  • Badges are only updated by pushes to main, because a manual run may use an older compiler.
  • A model with no result (compiler download or library build failed, or the job timed out) shows a red "no result".
  • The table shows an error until the first run after merging finishes and creates the branch. After that, updates can lag by about 5 minutes because of caching.
  • shields.io is a third-party service that renders the images.

Testing

  • Dry-ran the badge-writing step with made-up passing, failing and missing results: all 8 files came out correct.
  • Checked that all 8 README links point at those files, and that the new job's dependencies parse correctly.
  • Not run: the upload, collect and publish steps on GitHub. Those run for the first time when this merges. The first CI run from Run the tests in CI on every push to main; update the release workflow #76 was still in progress when this was opened, so its results aren't known yet.

🤖 Generated with Claude Code

ASDAlexander77 and others added 2 commits November 9, 2026 09:35
The badge of a workflow can only say how the whole of it went, so the
test jobs now record a result for each memory model and a final job
publishes them to the `badges` branch as shields.io endpoint files. The
README shows them as a table, with the overall Tests badge above it.

Only a push to main updates the badges: a manual run may use an older
compiler. A model with no result never reached its tests and shows red.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Until now a problem only showed up after the merge. The badges still
come from pushes to main alone.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ASDAlexander77
ASDAlexander77 merged commit 5c91cfb into main Nov 9, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant