1
0
mirror of synced 2025-12-22 11:26:57 -05:00

Update github-upload-results.md (#45184)

This commit is contained in:
Felicity Chapman
2023-10-27 18:33:37 +01:00
committed by GitHub
parent 8c794728d9
commit 29360c7583

View File

@@ -32,8 +32,7 @@ codeql github upload-results --sarif=<file> [--github-auth-stdin] [--github-url=
Uploads a SARIF file to GitHub code scanning.
See:
<https://docs.github.com/en/code-security/secure-coding/running-codeql-cli-in-your-ci-system#uploading-results-to-github>
See: [AUTOTITLE](/code-security/codeql-cli/getting-started-with-the-codeql-cli/uploading-codeql-analysis-results-to-github).
A GitHub Apps token or personal access token must be set. For best
security practices, it is recommended to set the `--github-auth-stdin`
@@ -51,8 +50,7 @@ This token must have the `security_events` scope.
\[Mandatory] Path to the SARIF file to upload. This should be the
output of [codeql database analyze](/code-security/codeql-cli/codeql-cli-manual/database-analyze) (or [codeql database interpret-results](/code-security/codeql-cli/codeql-cli-manual/database-interpret-results)) with `--format sarif-latest` for upload to github.com or
GitHub AE, or the appropriate supported format tag for GitHub Enterprise
Server instances (see <https://docs.github.com/> for the right value for
your release).
Server instances (see [AUTOTITLE](/enterprise-server@latest/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning#sariflog-object) for SARIF versions supported by your release).
#### `-r, --repository=<repository-name>`
@@ -97,8 +95,7 @@ upload.
`json`: Print the response body of the SARIF upload API request.
See also:
<https://docs.github.com/en/rest/reference/code-scanning#upload-an-analysis-as-sarif-data>
See also: [AUTOTITLE](/rest/code-scanning/code-scanning?apiVersion=2022-11-28#upload-an-analysis-as-sarif-data).
### Options to configure where to upload SARIF files.