Skip to main content

Setting up code scanning for a repository

You can set up 代码扫描 by adding a workflow to your repository.

If you have write permissions to a repository, you can set up or configure 代码扫描 for that repository.

代码扫描 is available for all public repositories on 代码扫描 is also available for private repositories owned by organizations that use GitHub Enterprise Cloud and have a license for GitHub Advanced Security. 更多信息请参阅“GitHub 的产品”。

Options for setting up 代码扫描

You decide how to generate 代码扫描 alerts, and which tools to use, at a repository level. GitHub provides fully integrated support for CodeQL analysis, and also supports analysis using third-party tools. For more information, see "About 代码扫描."

分析类型 用于生成警报的选项
CodeQL 使用 GitHub Actions(请参阅“使用操作设置 代码扫描 ”)或在第三方持续集成 (CI) 系统中运行 CodeQL 分析(请参阅“关于 CI 系统中的 CodeQL 代码扫描”)。
第三方 使用 GitHub Actions (请参阅“使用操作设置 代码扫描”)或在外部生成并上传到 GitHub (请参阅“将 SARIF 文件上传到 GitHub”)。

如果使用多个配置运行代码扫描,则有时警报将具有多个分析源。 如果一个警报有多个分析源,您可以在警报页面上查看每个分析源的警报状态。 更多信息请参阅“关于分析源”。

Setting up 代码扫描 using starter workflows

注意: Advanced Security 入门工作流程已合并到存储库的 Actions(操作) 选项卡的“Security(安全性)”类别中。 此新配置目前处于测试阶段,可能会发生更改。

GitHub 为安全功能(如 代码扫描) 提供了入门工作流程。 您可以使用这些建议的工作流程来构建 代码扫描 工作流程,而不是从头开始。 代码扫描 starter workflows are only available for your repository if 代码扫描 is enabled.

使用操作运行 代码扫描 将消耗分钟数。 更多信息请参阅“关于 GitHub Actions 的计费.”

  1. 在 上,导航到仓库的主页面。
  2. 在仓库名称下,单击 Actions(操作)主仓库导航中的操作选项卡
  3. If the repository has already at least one workflow set up and running, click New workflow and go to step 5. If there are currently no workflows configured for the repository, go to the next step. Screenshot of the New workflow button
  4. Scroll down to the "Security" category and click Configure under the workflow you want to configure, or click View all to see all available security workflows. Screenshot of the Actions workflows security section
  5. On the right pane of the workflow page, click Documentation and follow the on-screen instructions to tailor the workflow to your needs. Screenshot of the Documentation tab for starter workflows For more information, see "Using starter workflows" and "Configuring 代码扫描."

Setting up 代码扫描 manually

You can set up 代码扫描 in any public repository where you have write access.

使用操作运行 代码扫描 将消耗分钟数。 更多信息请参阅“关于 GitHub Actions 的计费.”

  1. 在 上,导航到仓库的主页面。

  2. 在仓库名称下,单击 Security(安全)Security 选项卡

  3. To the right of "代码扫描 alerts", click Set up 代码扫描. For more information, see "Managing security and analysis settings for your organization" or "Managing security and analysis settings for your repository." "Set up 代码扫描" button to the right of "代码扫描" in the Security Overview

  4. Under "Get started with 代码扫描", click Set up this workflow on the CodeQL 分析工作流程 or on a third-party workflow. "Set up this workflow" button under "Get started with 代码扫描" headingWorkflows are only displayed if they are relevant for the programming languages detected in the repository. The CodeQL 分析工作流程 is always displayed, but the "Set up this workflow" button is only enabled if CodeQL analysis supports the languages present in the repository.

  5. To customize how 代码扫描 scans your code, edit the workflow.

    Generally you can commit the CodeQL 分析工作流程 without making any changes to it. However, many of the third-party workflows require additional configuration, so read the comments in the workflow before committing.

    For more information, see "Configuring 代码扫描."

  6. Use the Start commit drop-down, and type a commit message. Start commit

  7. Choose whether you'd like to commit directly to the default branch, or create a new branch and start a pull request. Choose where to commit

  8. Click Commit new file or Propose new file.

In the default CodeQL 分析工作流程, 代码扫描 is configured to analyze your code each time you either push a change to the default branch or any protected branches, or raise a pull request against the default branch. As a result, 代码扫描 will now commence.

The on:pull_request and on:push triggers for code scanning are each useful for different purposes. For more information, see "Scanning pull requests" and "Scanning on push."

Bulk set up of 代码扫描

You can set up 代码扫描 in many repositories at once using a script. If you'd like to use a script to raise pull requests that add a GitHub Actions workflow to multiple repositories, see the jhutchings1/Create-ActionsPRs repository for an example using PowerShell, or nickliffen/ghas-enablement for teams who do not have PowerShell and instead would like to use NodeJS.

Viewing the logging output from 代码扫描

After setting up 代码扫描 for your repository, you can watch the output of the actions as they run.

  1. 在仓库名称下,单击 Actions(操作)主仓库导航中的操作选项卡

    You'll see a list that includes an entry for running the 代码扫描 workflow. The text of the entry is the title you gave your commit message.

    Actions list showing 代码扫描 workflow

  2. Click the entry for the 代码扫描 workflow.

  3. Click the job name on the left. For example, Analyze (LANGUAGE).

    Log output from the 代码扫描 workflow

  4. Review the logging output from the actions in this workflow as they run.

  5. Once all jobs are complete, you can view the details of any 代码扫描 alerts that were identified. For more information, see "Managing 代码扫描 alerts for your repository."

Note: If you raised a pull request to add the 代码扫描 workflow to the repository, alerts from that pull request aren't displayed directly on the 代码扫描 page until the pull request is merged. If any alerts were found you can view these, before the pull request is merged, by clicking the n alerts found link in the banner on the 代码扫描 page.

Click the "n alerts found" link

Understanding the pull request checks

Each 代码扫描 workflow you set to run on pull requests always has at least two entries listed in the checks section of a pull request. There is one entry for each of the analysis jobs in the workflow, and a final one for the results of the analysis.

The names of the 代码扫描 analysis checks take the form: "TOOL NAME / JOB NAME (TRIGGER)." For example, for CodeQL, analysis of C++ code has the entry "CodeQL / Analyze (cpp) (pull_request)." You can click Details on a 代码扫描 analysis entry to see logging data. This allows you to debug a problem if the analysis job failed. For example, for 代码扫描 analysis of compiled languages, this can happen if the action can't build the code.

代码扫描 pull request checks

When the 代码扫描 jobs complete, GitHub works out whether any alerts were added by the pull request and adds the "代码扫描 results / TOOL NAME" entry to the list of checks. After 代码扫描 has been performed at least once, you can click Details to view the results of the analysis. If you used a pull request to add 代码扫描 to the repository, you will initially see an "Analysis not found" message when you click Details on the "代码扫描 results / TOOL NAME" check.

Analysis not found for commit message

The table lists one or more categories. Each category relates to specific analyses, for the same tool and commit, performed on a different language or a different part of the code. For each category, the table shows the two analyses that 代码扫描 attempted to compare to determine which alerts were introduced or fixed in the pull request.

For example, in the screenshot above, 代码扫描 found an analysis for the merge commit of the pull request, but no analysis for the head of the main branch.

Reasons for the "Analysis not found" message

After 代码扫描 has analyzed the code in a pull request, it needs to compare the analysis of the topic branch (the branch you used to create the pull request) with the analysis of the base branch (the branch into which you want to merge the pull request). This allows 代码扫描 to compute which alerts are newly introduced by the pull request, which alerts were already present in the base branch, and whether any existing alerts are fixed by the changes in the pull request. Initially, if you use a pull request to add 代码扫描 to a repository, the base branch has not yet been analyzed, so it's not possible to compute these details. In this case, when you click through from the results check on the pull request you will see the "Analysis not found" message.

There are other situations where there may be no analysis for the latest commit to the base branch for a pull request. These include:

  • The pull request has been raised against a branch other than the default branch, and this branch hasn't been analyzed.

    To check whether a branch has been scanned, go to the 代码扫描 page, click the Branch drop-down and select the relevant branch.

Choose a branch from the Branch drop-down menu

The solution in this situation is to add the name of the base branch to the on:push and on:pull_request specification in the 代码扫描 workflow on that branch and then make a change that updates the open pull request that you want to scan.

  • The latest commit on the base branch for the pull request is currently being analyzed and analysis is not yet available.

    Wait a few minutes and then push a change to the pull request to retrigger 代码扫描.

  • An error occurred while analyzing the latest commit on the base branch and analysis for that commit isn't available.

    Merge a trivial change into the base branch to trigger 代码扫描 on this latest commit, then push a change to the pull request to retrigger 代码扫描.

Next steps

After setting up 代码扫描, and allowing its actions to complete, you can: