Update documentation around how osv-scanner ignores should be written #7115
+38
−13
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.
This PR has improvements and clarifications around what we should do when
osv-scanner
reports a vulnerability. The original cause for this PR was that it was unclear if we were allowed to ignore entire packages, and how to write such aPackageOverrides
entry. Then I also took the opportunity to improve the beginning of the document, taking a broader view of how to handle vulnerability reports overall.I also slightly changed the order of some paragraphs to make them come in a bit more of a priority order. Priority in the sense that expiry date and reason are the most important fields to specify correctly. The exact format of
id
is not as important to get right.This change is