Chore/update aibom test docs - #1655
Open
sburuiana-snyk wants to merge 3 commits into
Open
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
9 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.
Updates snyk aibom test documentation to match current CLI behavior:
--severity-thresholdparameter;Note
Low Risk
Markdown-only documentation changes with no runtime or security impact.
Overview
Updates snyk aibom test help and cross-references so they match how the command works today.
The aibom-test page no longer describes open vs ignored issue groupings, closed issues in JSON, or separate open/ignored counts in the test summary. Output is described as a single issue list and severity-based summary. Exit codes and
--severity-thresholdare clarified: exit1applies to issues at or above the threshold (defaultlow), and the threshold filters the console report, summary, and--json-file-output.The CLI commands summary and severity thresholds guide now list
snyk aibom testfor--severity-thresholdand extend--json-file-outputunder the aibom options to include test.Reviewed by Cursor Bugbot for commit b1dbc25. Bugbot is set up for automated code reviews on this repo. Configure here.