Update recommended usage to preserve diagnostics for failed runs#13
Merged
aegilops merged 2 commits intoMar 11, 2024
Conversation
`upload: failure-only` will still upload a SARIF file with diagnostic information to display on the status page when the run fails. Also specify the category earlier on so this can be injected by CodeQL into the SARIF file.
aegilops
approved these changes
Mar 11, 2024
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
2 participants
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 makes some changes to the recommended usage of this Action:
upload: failure-onlyinstead ofupload: false. This means that diagnostic output is still uploaded and visible on the tool status page if the run fails. (See https://github.com/github/codeql-action/blob/7bde9061b48b68e993ca909411613cf15bd12708/analyze/action.yml#L15)categoryinput to theanalyzeAction so that we can inject this with CodeQL rather than needing to post-process the SARIF in theupload-sarifAction.