Skip to content

docs(#1818): add opt-in/fail-closed exception to effective_on guidance #1819

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(#1818): add opt-in/fail-closed exception to effective_on guidance #1819

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
4 changes: 4 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,10 @@ Rego is a declarative policy language (Datalog-inspired), not imperative code:
rule and verify it includes `effective_on: <future RFC 3339 date>`. See existing rules in
`policy/release/` for the pattern. Rule data entries in `example/data/` YAML files (e.g.,
`required_tasks.yml`, `trusted_tekton_tasks.yml`) also use `effective_on` for data-driven rules.
**Exception:** Rules that are both opt-in (require explicit user configuration to activate) and
fail-closed (produce no output when unconfigured) may omit `effective_on`, since unconfigured
builds are unaffected. When omitting `effective_on` for this reason, document the rationale in the
PR description.
- **Collection membership:** New rules must declare membership in the appropriate collection(s) via
the `collections:` key in their METADATA annotation. See existing rules in `policy/release/` for
the pattern.
Expand Down
Loading