docs: badge what this repository actually guarantees - #1
Conversation
Every sibling repository carries a row of trust signals and this one carried none, so a visitor had no at-a-glance answer to "is this maintained, what may I do with it, and where do changes go". Three badges, each backed by something real here: - **Generated-only** -- the workflow of the same name, which regenerates from the pinned catalog sources and fails on any difference. That is not a lint, it is this repository's security argument: what you install is exactly what the catalog published. It is the badge most worth having here, so it leads. - **License Apache 2.0** -- the LICENSE already in the repository. - **Contribute upstream -> chock-catalog** -- deliberately NOT the "PRs welcome" badge every sibling carries. This repository closes hand-written pull requests by design (see close-prs.yml); review belongs where the source is. A "PRs welcome" here would invite people into a pull request that gets closed unread, which is worse than no badge at all. No OpenSSF Scorecard badge: there is no scorecard workflow in this repository, and a badge for a check that does not run is exactly the kind of claim this project exists not to make. Signed-off-by: Claude <noreply@anthropic.com>
|
|
What fails: the generated-only check regenerates the whole tree from Why it cannot be fixed here: the check compares the entire generated tree, so the only thing that clears it is republishing that tree at v0.7.0 — Where that stands: the dry run at No re-run requested: this is a deterministic version gap, not a flake, and a second run would fail identically. This pull request goes green on its own once the republish lands. Generated by Claude Code |
What
Every sibling repository carries a row of trust signals; this one carried none. A visitor had no at-a-glance answer to is this maintained, what may I do with it, and where do changes go.
Three badges, each backed by something real in this repository:
.github/workflows/generated-only.ymlLICENSE.github/workflows/close-prs.ymlGenerated-only leads deliberately. As its own workflow comment says, that check "is not a lint, it is the security argument": it regenerates from the pinned catalog sources and fails on any difference, so what a user installs is exactly what the catalog published. For a repository asking people to approve a hook trust review before its guards can block, the check backing that guarantee should be the first thing on the page.
What is deliberately not here
No "PRs welcome" badge, though every sibling carries one. This repository closes hand-written pull requests by design — review belongs where the source is. A "PRs welcome" badge would walk people into a pull request that gets closed unread, which is worse than no badge at all. The third badge states the true thing instead.
No OpenSSF Scorecard badge. There is no scorecard workflow here, and a badge for a check that does not run is exactly the kind of claim this project exists not to make.
Note on
close-prs.ymlThis PR is on a branch in this repository, not a fork, so the redirect workflow's fork-only condition leaves it alone — matching its own comment that "a branch in this repository is the maintainer's own infrastructure work".
Status
mainwas republished at framework v0.7.0 (1376438), and this branch has been updated onto it, so theverifyfailure noted in the comment below is resolved.Same pass applied across the org: chock-claude-plugins, chock-cursor-plugins, chock-copilot-plugins, chock-quickstart, chock-example, chock-threat-intel, agentseam and chock-catalog.