feat: add 'primary' locations #328
Merged
Conversation
This file contains 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
Signed-off-by: William Woodruff <william@yossarian.net>
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.
This was pointed out by @fcasal: the current model assumes that all locations are equal, while SARIF distinguishes between "primary" locations (i.e. those in
locations) and "secondary" locations (i.e. those inrelatedLocations). This is especially relevant for SARIF presentation tools like GH itself, which assume thatlocationsonly contains a single member.This tweaks our models and updates all audits to emit a "primary" location for the most salient part of each finding. The salient part of each finding is subjective.
This should improve the presentation quality for our SARIF outputs. One downside to this approach is that every audit needs to explicitly annotate a primary location.
Fixes #66.