Add --sarif-group-rules-by-pack flag
#546
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
adityasharad
approved these changes
Jun 4, 2021
There was a problem hiding this comment.
Thanks!
Could you please add a change note? You can link to https://codeql.github.com/docs/codeql-cli/manual/database-analyze/#cmdoption-codeql-database-analyze-no-sarif-group-rules-by-pack or https://github.com/github/codeql-cli-binaries/blob/main/CHANGELOG.md#release-251-2021-04-19, or use the text there as a reference while writing the note. I want to make clear that this will not change most behaviour, but the rule objects will be in different places in the SARIF produced.
edoardopirovano
force-pushed
the
add-group-by-pack
branch
from
d58d532 to
4a407fe
Compare
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 adds the
--sarif-group-rules-by-packto invocations ofdatabase analyzewhich will result in the SARIF produced having rule objects grouped under the QL pack they correspond to rather than appearing at the top level.Merge / deployment checklist
Confirm this change is backwards compatible with existing workflows.This change isn't quite compatible with existing workflows if the users are consuming the SARIF in a way other than uploading it to Code Scanning, as thetool.driver.rulesfield disappears in favour of<toolComponent>.rulesfields. As I understand it we don't support this use case, though.