github/codeql-action/analyze@v4

Finalize CodeQL database

At a glance

Latest major
v4
Repository
github/codeql-action
Inputs
18 (1 required)
Outputs
3
Runs using
node24
License
MIT
Last checked

Inputs and outputs come straight from the action's official action.yml. See our editorial standards.

Usage

- uses: github/codeql-action/analyze@v4

Inputs

NameRequiredDefaultDescription
check_nameNononeThe name of the check run to add text to.
outputNo../resultsThe path of the directory in which to save the SARIF results from the CodeQL CLI.
uploadNoalwaysUpload the SARIF file to Code Scanning. Defaults to 'always' which uploads the SARIF file to Code Scanning for successful and failed runs. '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. '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.
cleanup-levelNononeDEPRECATED. This option is ignored since, for performance reasons, the CodeQL Action automatically manages cleanup of intermediate results.
ramNononeThe amount of memory in MB that can be used by CodeQL for database finalization and query execution. By default, this action will use the same amount of memory as previously set in the "init" action. If the "init" action also does not have an explicit "ram" input, this action will use most of the memory available in the system (which for GitHub-hosted runners is 6GB for Linux, 5.5GB for Windows, and 13GB for macOS).
add-snippetsNononeDeprecated The input "add-snippets" has been removed and no longer has any effect.
skip-queriesNofalseIf this option is set, the CodeQL database will be built but no queries will be run on it. Thus, no results will be produced.
threadsNononeThe number of threads that can be used by CodeQL for database finalization and query execution. By default, this action will use the same number of threads as previously set in the "init" action. If the "init" action also does not have an explicit "threads" input, this action will use all the hardware threads available in the system (which for GitHub-hosted runners is 2 for Linux and Windows and 3 for macOS).
checkout_pathNo${{ github.workspace }}The path at which the analyzed repository was checked out. Used to relativize any absolute paths in the uploaded SARIF file.
refNononeThe ref where results will be uploaded. If not provided, the Action will use the GITHUB_REF environment variable. If provided, the sha input must be provided as well. This input is ignored for pull requests from forks. Expected format: refs/heads/<branch name>, refs/tags/<tag>, refs/pull/<number>/merge, or refs/pull/<number>/head.
shaNononeThe sha of the HEAD of the ref where results will be uploaded. If not provided, the Action will use the GITHUB_SHA environment variable. If provided, the ref input must be provided as well. This input is ignored for pull requests from forks.
categoryNononeString used by Code Scanning for matching the analyses
upload-databaseNotrueWhether to upload the resulting CodeQL database
post-processed-sarif-pathNononeBefore uploading the SARIF files produced by the CodeQL CLI, the CodeQL Action may perform some post-processing on them. Ordinarily, these post-processed SARIF files are not saved to disk. However, if a path is provided as an argument for this input, they are written to the specified directory.
wait-for-processingYestrueIf true, the Action will wait for the uploaded SARIF to be processed before completing.
tokenNo${{ github.token }}GitHub token to use for authenticating with this instance of GitHub. The token must be the built-in GitHub Actions token, and the workflow must have the `security-events: write` permission. Most of the time it is advisable to avoid specifying this input so that the workflow falls back to using the default value.
matrixNo${{ toJson(matrix) }}No description in action.yml.
expect-errorNofalse[Internal] It is an error to use this input outside of integration testing of the codeql-action.

Outputs

NameDescription
db-locationsA map from language to absolute path for each database created by CodeQL.
sarif-outputAbsolute, local path to the directory containing the generated SARIF file.
sarif-idThe ID of the uploaded SARIF file.

Read an output with ${{ steps.<step-id>.outputs.<name> }}; the step needs an id.

Examples

Finish the CodeQL scan

Runs the queries and uploads results to the Security tab; needs `init` first.

name: Example
on:
  push:
    branches: [main]

permissions:
  contents: read
  security-events: write

jobs:
  example:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - uses: github/codeql-action/init@v4
        with:
          languages: javascript-typescript
      - name: "CodeQL: Finish"
        uses: github/codeql-action/analyze@v4
        with:
          category: "/language:javascript-typescript"

Each example passed actionlint (syntax, expressions and the inputs it knows for this action). They were not run in a live repository, so replace placeholder values such as names, ARNs and paths with your own.

Something out of date or wrong? Report it on our Contact page. This page is rebuilt from the action's repository roughly once a week.