A stranger submitting a rig had no way to pass the registry check: anything in registry/ that wasn't a full registry-entry.v1 (pinned commit, digests, views) failed. Submissions now go in registry/submissions/<name>.yaml with three fields, repository, folder and ref, checked against a small schema that reuses the entry format's own repository and folder rules. A well-formed submission passes with "Submission received", shown as a notice on the pull request. A malformed one fails and says what a submission needs. A file beside the entries that has no configurations is pointed to submissions/. Submissions are never listings: the status generator and the site read only registry/*.yaml, so a merged submission changes nothing they produce. File names in submissions/ are limited to plain characters, because they are echoed into CI output. Co-authored-by: OpenRig contributors <[email protected]>
1.6 KiB
Registry
Each file here lists one rig bundle on openrig.dev/rigs. An entry records exactly what a maintainer reviewed:
- the source repository and folder, at a full 40-character commit (and the branch or tag it was submitted as);
- each offered configuration, with its package digest, the OpenRig version that built it, and its generated
behaviour view (under
views/); - the review date, and whether it's
listedorwithdrawn.
Format: registry-entry.v1 in the OpenRig repository's docs/reference/bundle-formats.md.
The site shows only listed entries, at their recorded commit. A later push to the bundle's branch changes nothing
here until an update is reviewed and merged. A withdrawn entry leaves the lists.
Every listing carries the line: "Reviewed for listing on at commit . Review is not a security audit."
The registry check (tools/registry-check.mjs) runs on every pull request. It rejects entries that don't match the
format, commits that aren't 40 hex characters, configuration IDs that aren't canonical, behaviour views that are
missing or describe another package, and a status file that was edited by hand.
Submitting a rig
Add registry/submissions/<your-team>.yaml with three fields (see submissions/README.md): your repository, the
folder holding rig.yaml, and a branch, tag or commit. The check accepts it and says "Submission received". A
maintainer then writes the full entry here, at a pinned commit, and removes the submission. A submission is never
listed: the site and the status file read only the entries in this folder.