Commit a21bb7f
Update upload input values and logic (#1598)
- The `upload` input to the `analyze` Action now accepts the following values:
- `always` is the default value, which uploads the SARIF file to Code Scanning for successful and failed runs.
- `failure-only` is recommended for customers post-processing the SARIF file before uploading it to Code Scanning. This option uploads debugging information to Code Scanning for failed runs to improve the debugging experience.
- `never` avoids uploading the SARIF file to Code Scanning even if the code scanning run fails. This is not recommended for external users since it complicates debugging.
- The legacy `true` and `false` options will be interpreted as `always` and `failure-only` respectively.
---------
Co-authored-by: Henry Mercer <henry.mercer@me.com>1 parent 0214d1d commit a21bb7f
25 files changed
Lines changed: 206 additions & 89 deletions
File tree
- .github
- query-filter-test
- workflows
- analyze
- lib
- pr-checks/checks
- src
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -40,7 +40,7 @@ runs: | |||
| 40 | 40 | with: | |
| 41 | 41 | output: ${{ runner.temp }}/results | |
| 42 | 42 | upload-database: false | |
| 43 | - upload: false | ||
| 43 | + upload: never | ||
| 44 | 44 | env: | |
| 45 | 45 | CODEQL_ACTION_TEST_MODE: "true" | |
| 46 | 46 | - name: Check SARIF | |
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -36,7 +36,7 @@ jobs: | |||
| 36 | 36 | with: | |
| 37 | 37 | output: ${{ runner.temp }}/results | |
| 38 | 38 | upload-database: false | |
| 39 | - upload: false | ||
| 39 | + upload: never | ||
| 40 | 40 | ||
| 41 | 41 | - name: Check Sarif | |
| 42 | 42 | uses: ./../action/.github/check-sarif | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -7,6 +7,13 @@ No user facing changes. | |||
| 7 | 7 | ## 2.2.8 - 22 Mar 2023 | |
| 8 | 8 | ||
| 9 | 9 | - Update default CodeQL bundle version to 2.12.5. [#1585](https://github.com/github/codeql-action/pull/1585) | |
| 10 | + - Customers post-processing the SARIF output of the `analyze` Action before uploading it to Code Scanning will benefit from an improved debugging experience. [#1598](https://github.com/github/codeql-action/pull/1598) | ||
| 11 | + - The CodeQL Action will now upload a SARIF file with debugging information to Code Scanning on failed runs for customers using `upload: false`. Previously, this was only available for customers using the default value of the `upload` input. | ||
| 12 | + - The `upload` input to the `analyze` Action now accepts the following values: | ||
| 13 | + - `always` is the default value, which uploads the SARIF file to Code Scanning for successful and failed runs. | ||
| 14 | + - `failure-only` is recommended for customers post-processing the SARIF file before uploading it to Code Scanning. This option uploads debugging information to Code Scanning for failed runs to improve the debugging experience. | ||
| 15 | + - `never` avoids uploading the SARIF file to Code Scanning even if the code scanning run fails. This is not recommended for external users since it complicates debugging. | ||
| 16 | + - The legacy `true` and `false` options will be interpreted as `always` and `failure-only` respectively. | ||
| 10 | 17 | ||
| 11 | 18 | ## 2.2.7 - 15 Mar 2023 | |
| 12 | 19 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -10,10 +10,14 @@ inputs: | |||
| 10 | 10 | required: false | |
| 11 | 11 | default: "../results" | |
| 12 | 12 | upload: | |
| 13 | - description: Upload the SARIF file to Code Scanning | ||
| 13 | + description: >- | ||
| 14 | + Upload the SARIF file to Code Scanning. | ||
| 15 | + Defaults to 'always' which uploads the SARIF file to Code Scanning for successful and failed runs. | ||
| 16 | + 'failure-only' only uploads debugging information to Code Scanning if the workflow run fails, for users post-processing the SARIF file before uploading it to Code Scanning. | ||
| 17 | + 'never' avoids uploading the SARIF file to Code Scanning, even if the code scanning run fails. This is not recommended for external users since it complicates debugging. | ||
| 14 | 18 | required: false | |
| 15 | 19 | # If changing this, make sure to update workflow.ts accordingly. | |
| 16 | - default: "true" | ||
| 20 | + default: "always" | ||
| 17 | 21 | cleanup-level: | |
| 18 | 22 | description: "Level of cleanup to perform on CodeQL databases at the end of the analyze step. This should either be 'none' to skip cleanup, or be a valid argument for the --mode flag of the CodeQL CLI command 'codeql database cleanup' as documented at https://codeql.github.com/docs/codeql-cli/manual/database-cleanup" | |
| 19 | 23 | required: false | |
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
0 commit comments