Skip to content

docs(#1784): correct collection-registration guidance in AGENTS.md #1785

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fullsend-ai-coder wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(#1784): correct collection-registration guidance in AGENTS.md #1785

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,11 @@ Every policy rule requires METADATA annotations. Missing or malformed annotation

## Architecture (design rationale and non-obvious parts)

**Collections** (`policy/*/collection/`) group related rules. Each collection imports specific policy
packages. Examples: `minimal` (basic validation), `slsa3` (SLSA Level 3), `redhat` (Red Hat-specific).
When adding a new rule, you must add it to the appropriate collection(s) or it won't be evaluated.
**Collections** (`policy/*/collection/`) group related rules. Collection files are minimal package
declarations (e.g., `package collection.minimal`) — they do not import policy packages. Rules declare
their own collection membership via a `collections:` list in their METADATA `custom:` annotations
(see `policy/release/attestation_type/attestation_type.rego` for the pattern). Examples: `minimal`
(basic validation), `slsa3` (SLSA Level 3), `redhat` (Red Hat-specific).

**SLSA dual-format:** The library in `policy/lib/tekton/` normalizes both SLSA v0.2 and v1.0
attestation formats. Policies consume the normalized form — don't branch on SLSA version in rules.
Expand All @@ -63,7 +65,7 @@ These files have `effective_on` dates — rules with future dates are warnings,
- **Add a pipeline policy rule:** follow the pattern in `policy/pipeline/required_tasks.rego`
- **Add a shared library function:** see `policy/lib/tekton/` for reference implementation (must have test coverage)
- **Fetch and parse an OCI blob:** use `oci.parsed_blob(ref)` from `data.lib.oci`, not `json.unmarshal(ec.oci.blob(ref))` directly. A Regal lint rule (`prefer-parsed-blob`) enforces this
- **Add a new collection:** follow the pattern in `policy/release/collection/` — import specific policy packages
- **Add a new collection:** follow the pattern in `policy/release/collection/` — a minimal package declaration (no imports needed)

## PR Conventions

Expand Down
Loading