jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-22 11:26:57 -05:00
Code Issues Projects Releases Wiki Activity

Update CodeQL CLI manual (#46039)

Browse Source 
Co-authored-by: Sam Browning <106113886+sabrowning1@users.noreply.github.com>
This commit is contained in:
docs-bot
2023-11-13 10:43:05 -05:00
committed by GitHub
parent c99df4ee12
commit 3d34415805
73 changed files with 800 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
content/code-security/codeql-cli/codeql-cli-manual/github-upload-results.md
View File

@@ -32,7 +32,7 @@ codeql github upload-results --sarif=<file> [--github-auth-stdin] [--github-url=
Uploads a SARIF file to GitHub code scanning.
See: [AUTOTITLE](/code-security/codeql-cli/getting-started-with-the-codeql-cli/uploading-codeql-analysis-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`
@@ -50,7 +50,8 @@ 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 [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).
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>`
@@ -95,7 +96,7 @@ upload.
`json`: Print the response body of the SARIF upload API request.
See also: [AUTOTITLE](/rest/code-scanning/code-scanning?apiVersion=2022-11-28#upload-an-analysis-as-sarif-data).
See also: [AUTOTITLE](/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data)
### Options to configure where to upload SARIF files.
@@ -145,3 +146,13 @@ the running subcommand.
(To write a log file with a name you have full control over, instead
give `--log-to-stderr` and redirect stderr as desired.)
#### `--common-caches=<dir>`
\[Advanced] Controls the location of cached data on disk that will
persist between several runs of the CLI, such as downloaded QL packs and
compiled query plans. If not set explicitly, this defaults to a
directory named `.codeql` in the user's home directory; it will be
created if it doesn't already exist.
Available since `v2.15.2`.