docs: label the CI badge as tests and add a version badge - #30
Merged
Conversation
The workflow badge read "validate", which says nothing about what it guards. It is now labelled "tests" - green means the hook suites passed, since they are the first thing the workflow runs and nothing downstream can turn a failed run green. The one imprecision is worth stating: a red badge can also mean a manifest or frontmatter check failed, not only a test. The version badge tracks the newest tag, which is the version the marketplace serves - useful next to a plugin whose update flow is manual on both steps.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two of the three things asked for here already existed, so this PR is only the part that did not.
Tests already run in CI.
.github/workflows/validate.ymlrunsnode --test hooks/dispatch-counter.test.mjs hooks/update-check.test.mjson every push and pull request, and has since before this release. A badge already existed too - it just readvalidate, which tells a reader nothing about what is being guarded.So: the badge is relabelled
tests, and a version badge is added.Green on the tests badge means the hook suites passed - they are the workflow's first step and nothing downstream can turn a failed run green. The imprecision worth stating plainly: a RED badge can also mean a manifest or frontmatter check failed rather than a test. Splitting the workflow in two to make the badge exact would double the CI runs to remove an ambiguity that only appears when something is already broken.
The version badge tracks the newest tag, which is the version the marketplace serves. That is worth showing next to a plugin whose update flow is manual on both steps - catalog refresh and install - and it lets someone compare against what their own notice reports.
Both badge URLs were fetched before committing rather than assumed: the tests badge renders
passing, the version badge rendersv0.14.0.The repository About was filled in separately, since it is repo metadata rather than a file: description set, and three topics added (
subagents,cost-optimization,reasoning-effort) on top of the four already there. Homepage left empty on purpose - there is no site, and pointing it back at this same repo is noise.