Add machine-readable registry.yaml, generate README table - #45
Merged
Conversation
Adds registry.yaml as the authoritative, machine-readable plugin index (rule ID range, repository, type, status, license), validated against registry-schema.json in CI. README.md's table and registry.json are generated from it by scripts/generate_registry.py; CI regenerates and fails on drift instead of committing from the workflow. Migrating the table into registry.yaml also fixes the drift found in the audit: swapped CI badges between nextcloud/dokuwiki (now derived from each plugin's own repository field, making the swap structurally impossible), the missing License cell on false-positive-report-plugin, dokuwiki's link-text typo, missing CI badges on body-decompress-plugin and traffic-observation-plugin despite having integration tests, and documents the undocumented 9,515,000-9,515,999 hole as a reserved range. Also corrects vimbadmin-crs-plugin's license, which the table listed as GPL 2.0 but is actually Apache-2.0. Refs #21 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
theseion
approved these changes
Sep 7, 2026
4 tasks
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
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.
Summary
registry.yamlas the authoritative, machine-readable plugin index (rule ID range, repository, type, status, license, CI, private), validated againstregistry-schema.jsonin CI.README.md's table andregistry.jsonare generated fromregistry.yamlbyscripts/generate_registry.py. CI regenerates and fails on drift (git diff --exit-code) instead of committing from the workflow.repositoryfield, making the swap structurally impossible), the missing License cell onfalse-positive-report-plugin, dokuwiki's link-text typo, missing CI badges onbody-decompress-pluginandtraffic-observation-plugindespite having integration tests, and documents the undocumented 9,515,000-9,515,999 hole as areservedrange.vimbadmin-crs-plugin's license, which the table listed as GPL 2.0 but is actually Apache-2.0 per the repository's detected license.docs/registry-schema.mddocumenting the fields and, per the issue, what the registry attests and what it does not (not a code audit or supply-chain guarantee)..github/workflows/validate-registry.yml: schema validation viacheck-jsonschema, semantic validation (unique names, no overlapping rule ID ranges — constraints JSON Schema can't express) via a small script-based test, and the drift check.Refs #21.
Test plan
uvx check-jsonschema --schemafile registry-schema.json --force-filetype yaml registry.yaml tests/registry/valid/*.yamlpassestests/registry/invalid/*.yamlis rejected by the schemauv run tests/registry/test_validate.pypasses (duplicate-name and overlapping-range fixtures undertests/registry/invalid-semantic/are correctly rejected)uv run scripts/generate_registry.pyregeneratesREADME.mdandregistry.jsonwith no drift against the committed versionsplugin-schema.json, examples,plugin.yaml.template) still passes unaffected🤖 Generated with Claude Code