docs(#1753): add default values section to CVE package docs#1756
Open
fullsend-ai-coder[bot] wants to merge 1 commit into
Open
docs(#1753): add default values section to CVE package docs#1756fullsend-ai-coder[bot] wants to merge 1 commit into
fullsend-ai-coder[bot] wants to merge 1 commit into
Conversation
Add a "Default values" section to the CVE package documentation that
lists each rule data key with its actual default value from
rule_data.rego. This makes it easy for users to see the defaults
without reading the source code.
Also relabel the existing example YAML block as "Example rule data
(non-default)" and fix a typo in the example intro ("if" -> "of")
to clearly distinguish customization examples from actual defaults.
Changes:
- policy/release/cve/cve.rego: Updated METADATA annotations to
include a defaults section with a link to rule_data.rego, and
relabeled the existing example block.
- antora/docs/*: Regenerated via make generate-docs.
Note: make test could not run in the sandbox (unshare not permitted).
Tests were run directly via ec opa test and all 17 CVE tests passed.
Closes #1753
|
🤖 Finished Review · ✅ Success · Started 10:44 AM UTC · Completed 10:54 AM UTC |
Codecov Report✅ All modified and coverable lines are covered by tests.
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
|
Looks good to me FindingsLow
|
![fullsend-ai-review[bot]](https://avatars.githubusercontent.com/in/3478501?s=60&v=4){kind=small}
fullsend-ai-review
Bot
added
the
ready-for-merge
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.
Add a "Default values" section to the CVE package documentation that lists each rule data key with its actual default value from rule_data.rego. This makes it easy for users to see the defaults without reading the source code.
Also relabel the existing example YAML block as "Example rule data (non-default)" and fix a typo in the example intro ("if" -> "of") to clearly distinguish customization examples from actual defaults.
Changes:
include a defaults section with a link to rule_data.rego, and
relabeled the existing example block.
Note: make test could not run in the sandbox (unshare not permitted). Tests were run directly via ec opa test and all 17 CVE tests passed.
Closes #1753
Post-script verification
agent/1753-document-cve-defaults)71f6e6cf3f4e90d51f66207404e70034b501b3f7..HEAD)