docs/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-advanced-setup-for-code-scanning.md at c13a7af4cb4c79ca494987435a173156490c7ebc

mirror of synced 2025-12-19 18:10:59 -05:00

Files

Sam Browning c13a7af4cb [MVP] Refactor code scanning docs to prioritize default setup (#38572 )

Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com>
Co-authored-by: Dorothy Mitchell <dorothymitchell@github.com>
Co-authored-by: Felicity Chapman <felicitymay@github.com>
Co-authored-by: Grace Park <gracepark@github.com>

2023-07-17 15:42:37 +00:00

20 KiB

Raw Blame History

title, shortTitle, intro, product, permissions, versions, type, topics, allowTitleToDifferFromFilename

title

shortTitle

intro

product

permissions

versions

type

topics

allowTitleToDifferFromFilename

Configuring {% ifversion code-scanning-without-workflow %}advanced setup for {% endif %}code scanning

Configure {% ifversion code-scanning-without-workflow %}advanced setup{% else %}{% data variables.product.prodname_code_scanning %}{% endif %}

You can configure {% ifversion code-scanning-without-workflow %}advanced setup{% else %}{% data variables.product.prodname_code_scanning %}{% endif %} for a repository to find security vulnerabilities in your code{% ifversion code-scanning-without-workflow %} using a highly customizable {% data variables.product.prodname_code_scanning %} configuration{% endif %}.

{% data reusables.gated-features.code-scanning %}

People with admin permissions to a repository, or the security manager role for the repository, can configure {% data variables.product.prodname_code_scanning %} for that repository. People with write permissions to a repository can also configure {% data variables.product.prodname_code_scanning %}, but only by creating a workflow file or manually uploading a SARIF file.

fpt	ghes	ghae	ghec
*	*	*	*

how_to

Advanced Security

Code scanning

Actions

Repositories

true

{% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning-actions %}

About {% ifversion code-scanning-without-workflow %}advanced setup for {% endif %}{% data variables.product.prodname_code_scanning %}

{% ifversion code-scanning-without-workflow %} Advanced setup for {% data variables.product.prodname_code_scanning %} is helpful when you need more granular control over your {% data variables.product.prodname_code_scanning %} configuration. By creating and editing a {% data variables.product.prodname_codeql %} workflow file, you can change the scan schedule, scan any {% data variables.product.prodname_codeql %}-supported language, use a matrix build, and more.

{% else %} {% data variables.product.prodname_code_scanning_caps %} helps you catch vulnerabilities in the code in your repository. With {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}, you can select custom or built-in query suites for use in your analysis, set a specific scan schedule, choose which events trigger a scan, and more. {% endif %}

You can also configure {% data variables.product.prodname_code_scanning %} with third-party tools. For more information, see "Configuring {% data variables.product.prodname_code_scanning %} using third-party actions."

{% data reusables.code-scanning.about-multiple-configurations-link %} {% data reusables.code-scanning.codeql-action-version-ghes %}

{% ifversion code-scanning-without-workflow %} If you do not need a highly customizable {% data variables.product.prodname_code_scanning %} configuration, consider using default setup for {% data variables.product.prodname_code_scanning %}. For more information on eligibility for default setup, see "AUTOTITLE." {% endif %}

Prerequisites

Your repository is eligible for {% ifversion code-scanning-without-workflow %}advanced setup{% else %}{% data variables.product.prodname_code_scanning %}{% endif %} if:

it uses {% data variables.product.prodname_codeql %}-supported languages or you plan to generate code scanning results with a third-party tool.
{% data variables.product.prodname_actions %} are enabled.{% ifversion fpt %}
it is publicly visible.{%- elsif ghec %}
it is publicly visible, or {% data variables.product.prodname_GH_advanced_security %} is enabled.{%- elsif ghes or ghae %}
{% data variables.product.prodname_GH_advanced_security %} is enabled.{% endif %}

{% ifversion ghae %} Before configuring {% data variables.product.prodname_code_scanning %} for a repository, you must ensure that there is at least one self-hosted {% data variables.product.prodname_actions %} runner available to the repository.

Enterprise owners, organization and repository administrators can add self-hosted runners. For more information, see "AUTOTITLE" and "AUTOTITLE." {% endif %}

{% ifversion code-scanning-without-workflow %}

Configuring advanced setup for a repository

Advanced setup for {% data variables.product.prodname_code_scanning %} is helpful when you need to customize your {% data variables.product.prodname_code_scanning %}. By creating and editing a workflow file, you can choose which queries to run, change the scan schedule, select the languages to scan, use a matrix build, and more.

Configuring advanced setup for {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %}

You can customize your {% data variables.product.prodname_code_scanning %} by creating and editing a workflow file. Selecting advanced setup generates a basic workflow file for you to customize.

{% data reusables.code-scanning.billing %}

{% ifversion fpt %} {% note %}

Note: You can configure {% data variables.product.prodname_code_scanning %} for any public repository where you have write access.

{% endnote %} {% endif %}

{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.user-settings.security-analysis %}

Scroll down to the "{% data variables.product.prodname_code_scanning_caps %}" section, select Set up {% octicon "triangle-down" aria-hidden="true" %}, then click Advanced.

{% note %}

Note: If you are switching from default setup to advanced setup, in the "{% data variables.product.prodname_code_scanning_caps %}" section, select {% octicon "kebab-horizontal" aria-label="Menu" %}, then click {% octicon "workflow" aria-hidden="true" %} Switch to advanced. In the pop-up window that appears, click Disable {% data variables.product.prodname_codeql %}.

{% endnote %}

$Screenshot of the "{% data variables.product.prodname_code_scanning_caps %}" section of "Code security and analysis" settings. The "Advanced setup" button is highlighted with an orange outline.$
To customize how {% data variables.product.prodname_code_scanning %} scans your code, edit the workflow.

Generally, you can commit the {% data variables.code-scanning.codeql_workflow %} 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 "AUTOTITLE" and "AUTOTITLE."
Click Commit changes... to display the commit changes form.
In the commit message field, type a commit message.
Choose whether you'd like to commit directly to the default branch, or create a new branch and start a pull request.
Click Commit new file to commit the workflow file to the default branch or click Propose new file to commit the file to a new branch.
If you created a new branch, click Create pull request and open a pull request to merge your change into the default branch.

In the suggested {% data variables.code-scanning.codeql_workflow %}, {% data variables.product.prodname_code_scanning %} 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, {% data variables.product.prodname_code_scanning %} will now commence.

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

{% else %}

Configuring {% data variables.product.prodname_code_scanning %} using the {% data variables.product.prodname_codeql %} action

{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %}

To the right of "{% data variables.product.prodname_code_scanning_caps %} alerts", click Set up {% data variables.product.prodname_code_scanning %}.{% ifversion ghec or ghes or ghae %} If "{% data variables.product.prodname_code_scanning %} alerts" is missing, you need to ask an organization owner or repository administrator to enable {% data variables.product.prodname_GH_advanced_security %}.{% endif %} For more information, see "AUTOTITLE" or "AUTOTITLE."
Under "Get started with {% data variables.product.prodname_code_scanning %}", click Set up this workflow on the {% data variables.code-scanning.codeql_workflow %} or on a third-party workflow.

Workflows are only displayed if they are relevant for the programming languages detected in the repository. The {% data variables.code-scanning.codeql_workflow %} is always displayed, but the "Set up this workflow" button is only enabled if {% data variables.product.prodname_codeql %} analysis supports the languages present in the repository.
To customize how {% data variables.product.prodname_code_scanning %} scans your code, edit the workflow.

Generally, you can commit the {% data variables.code-scanning.codeql_workflow %} 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 "AUTOTITLE" and "AUTOTITLE."
Click Commit changes... to display the commit changes form.
In the commit message field, type a commit message.
Choose whether you'd like to commit directly to the default branch, or create a new branch and start a pull request.
Click Commit new file or Propose new file.

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

{% endif %}

For information on bulk enablement, see "AUTOTITLE."

{% ifversion fpt or ghec %}

Configuring {% data variables.product.prodname_code_scanning %} using third-party actions

{% data reusables.advanced-security.starter-workflows-beta %}

{% data reusables.advanced-security.starter-workflow-overview %}

{% data reusables.code-scanning.billing %}

{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.actions-tab %}

If the repository has already at least one workflow configured and running, click New workflow to display starter workflows. If there are currently no workflows configured for the repository, go to the next step.
In the "Choose a workflow" or "Get started with {% data variables.product.prodname_actions %}" view, scroll down to the "Security" category and click Configure under the workflow you want to configure. You may need to click View all to find the security workflow you want to configure.
Follow any instructions in the workflow to customize it to your needs. For more general assistance about workflows, click Documentation on the right pane of the workflow page.

For more information, see "AUTOTITLE" and "AUTOTITLE."

{% endif %} {% ifversion ghes < 3.5 %}

Reasons for the "Analysis not found" message

If you used a pull request to add {% data variables.product.prodname_code_scanning %} to the repository, you will initially see an "Analysis not found" message when you click Details on the "{% data variables.product.prodname_code_scanning_caps %} results / TOOL NAME" check in a pull request.

$Screenshot of the details for a code scanning result. Under "GitHub Code Scanning / {% data variables.product.prodname_codeql %}" is the heading "1 analysis not found."$

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 {% data variables.product.prodname_code_scanning %} attempted to compare to determine which alerts were introduced or fixed in the pull request.

For example, in the screenshot above, {% data variables.product.prodname_code_scanning %} found an analysis for the merge commit of the pull request, but no analysis for the head of the main branch.

After {% data variables.product.prodname_code_scanning %} 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 {% data variables.product.prodname_code_scanning %} 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 {% data variables.product.prodname_code_scanning %} 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 {% data variables.product.prodname_code_scanning_caps %} page, click the Branch drop-down and select the relevant branch.

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 {% data variables.product.prodname_code_scanning %} 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 {% data variables.product.prodname_code_scanning %}.
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 {% data variables.product.prodname_code_scanning %} on this latest commit, then push a change to the pull request to retrigger {% data variables.product.prodname_code_scanning %}.