Running CodeQL runner in your CI system

注意：CodeQL runner 将被弃用。对于 GitHub Enterprise Server 3.0及更高版本，可以安装 CodeQL CLI 版本 2.6.3 来替换 CodeQL runner。

有关详细信息，请参阅 CodeQL 运行器弃用。有关迁移到 CodeQL CLI 的信息，请参阅从 CodeQL 运行器迁移到 CodeQL CLI。

Note: Your site administrator must enable code scanning for your GitHub Enterprise Server instance before you can use this feature. For more information, see "Configuring code scanning for your appliance."

About the CodeQL runner

The CodeQL runner is a tool you can use to run code scanning on code that you're processing in a third-party continuous integration (CI) system. Code scanning 是一项功能，可用于分析 GitHub 仓库中的代� �，以查找安全漏洞和编� �错误。分析发现的任何问题都显示在 GitHub Enterprise Server 中。 For information, see "About code scanning with CodeQL."

In many cases it is easier to set up CodeQL code scanning using the CodeQL CLI directly in your CI system.

Alternatively, you can use GitHub Actions to run code scanning within GitHub Enterprise Server. For information, see "Setting up code scanning for a repository."

The CodeQL runner is a command-line tool that runs CodeQL analysis on a checkout of a GitHub repository. You add the runner to your third-party system, then call the runner to analyze code and upload the results to GitHub Enterprise Server. These results are displayed as code scanning alerts in the repository.

Note:

The CodeQL runner is available to customers with an Advanced Security license.

Downloading the CodeQL runner

You can download the CodeQL runner from https://HOSTNAME/github/codeql-action/releases. On some operating systems, you may need to change permissions for the downloaded file before you can run it.

On Linux:

chmod +x codeql-runner-linux

On macOS:

chmod +x codeql-runner-macos
sudo xattr -d com.apple.quarantine codeql-runner-macos

On Windows, the codeql-runner-win.exe file usually requires no change to permissions.

Adding the CodeQL runner to your CI system

Once you download the CodeQL runner and verify that it can be executed, you should make the runner available to each CI server that you intend to use for code scanning. For example, you might configure each server to copy the runner from a central, internal location. Alternatively, you could use the REST API to get the runner directly from GitHub, for example:

wget https://HOSTNAME/github/codeql-action/releases/latest/download/codeql-runner-linux
chmod +x codeql-runner-linux

In addition to this, each CI server also needs:

A GitHub App or personal access token for the CodeQL runner to use. You must use an access token with the repo scope, or a GitHub App with the security_events write permission, and metadata and contents read permissions. For information, see "Building GitHub Apps" and "Creating a personal access token."
Access to the CodeQL bundle associated with this release of the CodeQL runner. This package contains queries and libraries needed for CodeQL analysis, plus the CodeQL CLI, which is used internally by the runner. For information, see "CodeQL CLI."

The options for providing access to the CodeQL bundle are:

Allow the CI servers access to https://HOSTNAME/github/codeql-action so that the CodeQL runner can download the bundle automatically.
Manually download/extract the bundle, store it with other central resources, and use the --codeql-path flag to specify the location of the bundle in calls to initialize the CodeQL runner.

Calling the CodeQL runner

You should call the CodeQL runner from the checkout location of the repository you want to analyze. The two main commands are:

init required to initialize the runner and create a CodeQL database for each language to be analyzed. These databases are populated and analyzed by subsequent commands.
analyze required to populate the CodeQL databases, analyze them, and upload results to GitHub Enterprise Server.

For both commands, you must specify the URL of GitHub Enterprise Server, the repository OWNER/NAME, and the GitHub Apps or personal access token to use for authentication. You also need to specify the location of the CodeQL bundle, unless the CI server has access to download it directly from the github/codeql-action repository.

You can configure where the CodeQL runner stores the CodeQL bundle for future analysis on a server using the --tools-dir flag and where it stores temporary files during analysis using --temp-dir.

To view the command-line reference for the runner, use the -h flag. For example, to list all commands run: codeql-runner-OS -h, or to list all the flags available for the init command run: codeql-runner-OS init -h (where OS varies according to the executable that you are using). For more information, see "Configuring code scanning in your CI system."

注意：

SARIF 上� 最多支持每次上� 5000 个结果。任何超过此限制的结果都将被忽略。如果工具生成太多结果，则应更新配置，以将重点放在最重要的规则或查询的结果上。
对于每次上� ，SARIF 上� 支持最大大小为 10 MB 的 gzip 压缩 SARIF 文件。任何超过此限制的上� 都将被拒绝。如果 SARIF 文件由于包含太多结果而过大，则应更新配置，以将重点放在最重要的规则或查询的结果上。

Basic example

This example runs CodeQL analysis on a Linux CI server for the octo-org/example-repo repository hosted on https://github.example.com. The process is very simple because the repository contains only languages that can be analyzed by CodeQL directly, without being built (that is, Go, JavaScript, Python, and TypeScript).

In this example, the server has access to download the CodeQL bundle directly from the github/codeql-action repository, so there is no need to use the --codeql-path flag.

Check out the repository to analyze.
Move into the directory where the repository is checked out.

Initialize the CodeQL runner and create CodeQL databases for the languages detected.

$ echo "$TOKEN" | /path/to-runner/codeql-runner-linux init --repository octo-org/example-repo
    --github-url https://github.example.com --github-auth-stdin
> Cleaning temp directory /srv/checkout/example-repo/codeql-runner
> ...
> Created CodeQL database at /srv/checkout/example-repo/codeql-runner/codeql_databases/javascript.

填充 CodeQL 数据库、进行分析并将结果上� 到 GitHub Enterprise Server。结果将显示在存储库的“安全”选项卡中。

$ echo "$TOKEN" | /path/to-runner/codeql-runner-linux analyze --repository octo-org/example-repo
    --github-url https://github.example.com --github-auth-stdin
    --commit 5b6a3078b31dc346e5ce7b86837d6abbe7a18bbd --ref refs/heads/my-branch
> Finalizing database creation
> ...
> POST /repos/octo-org/example-repo/code-scanning/sarifs - 202 in 786ms
> Successfully uploaded results

要将 code scanning 结果作为拉取请求检查上� ，请使用 --ref � �志指定拉取请求。我们建议设置 CodeQL runner 以便它在 pull_request Webhook 事件上运行。

$ echo "$TOKEN" | /path/to-runner/codeql-runner-linux analyze --repository octo-org/example-repo
    --github-url https://github.example.com --github-auth-stdin
    --commit 1dc7a1346e5ce7b86835b68bbda3078b37d6abbe --ref refs/pull/123/merge
> Finalizing database creation
> ...
> POST /repos/octo-org/example-repo/code-scanning/sarifs - 202 in 786ms
> Successfully uploaded results

有关查看 code scanning 警报的详细信息，请参阅“在拉取请求中会审代� �扫描警报”和“管理存储库的代� �扫描警报”。

Compiled language example

This example is similar to the previous example, however this time the repository has code in C/C++, C#, or Java. To create a CodeQL database for these languages, the CLI needs to monitor the build. At the end of the initialization process, the runner reports the command you need to set up the environment before building the code. You need to run this command, before calling the normal CI build process, and then running the analyze command.

Check out the repository to analyze.
Move into the directory where the repository is checked out.