* New Crowdin translations by Github Action * Revert broken translated files to English * fix mistranslated type * fix mistranslated dates * fix liquid operator * revert broken to english * revert broken translations to english * revert broken translations to english * fix broken liquid tag 😭 * fix tags Co-authored-by: Crowdin Bot <support+bot@crowdin.com>
12 KiB
title, shortTitle, intro, product, permissions, redirect_from, versions
| title | shortTitle | intro | product | permissions | redirect_from | versions | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Enabling code scanning for a repository | Enabling code scanning | You can enable {% data variables.product.prodname_code_scanning %} for your project's repository. | {% data reusables.gated-features.code-scanning %} | If you have write permissions to a repository, you can enable {% data variables.product.prodname_code_scanning %} for that repository. |
|
|
{% data reusables.code-scanning.beta %} {% data reusables.code-scanning.enterprise-enable-code-scanning-actions %}
Options for enabling {% data variables.product.prodname_code_scanning %}
You decide how you generate {% data variables.product.prodname_code_scanning %} alerts, and which tools you use, at a repository level. {% data variables.product.product_name %} provides fully integrated support for {% data variables.product.prodname_codeql %} analysis, and also supports analysis using third-party tools. For more information, see "About {% data variables.product.prodname_codeql %}."
{% data reusables.code-scanning.enabling-options %}
Enabling {% data variables.product.prodname_code_scanning %} using actions
{% if currentVersion == "free-pro-team@latest" %}Using actions to run {% data variables.product.prodname_code_scanning %} will use minutes. For more information, see "About billing for {% data variables.product.prodname_actions %}."{% endif %}
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-security %}
3. Under "Get started with code scanning", click Set up this workflow on the {% data variables.product.prodname_codeql_workflow %} or on a third-party workflow.
4. Under "Get started with {% data variables.product.prodname_code_scanning %}", click Set up this workflow on the {% data variables.product.prodname_codeql_workflow %} or on a third-party workflow.
5. To customize how {% data variables.product.prodname_code_scanning %} scans your code, edit the workflow.
Generally you can commit the {% data variables.product.prodname_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 "Configuring {% data variables.product.prodname_code_scanning %}."
6. Use the Start commit drop-down, and type a commit message.
7. Choose whether you'd like to commit directly to the default branch, or create a new branch and start a pull request.
8. Click Commit new file or Propose new file.
In the default {% data variables.product.prodname_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. For more information, see "Configuring {% data variables.product.prodname_code_scanning %}."
Bulk enabling {% data variables.product.prodname_code_scanning %}
You can enable {% data variables.product.prodname_code_scanning %} in many repositories in bulk using a script. For an example of a script that raises pull requests to add a {% data variables.product.prodname_actions %} workflow to multiple repositories, see the jhutchings1/Create-ActionsPRs repository.
Дальнейшие шаги
After you enable {% data variables.product.prodname_code_scanning %}, you can monitor analysis, view results, and further customize how you scan your code.
{% data reusables.repositories.actions-tab %}
You'll see a list that includes an entry for running the {% data variables.product.prodname_code_scanning %} workflow. The text of the entry is the title you gave your commit message.
-
Click the entry for the {% data variables.product.prodname_code_scanning %} workflow.
-
Click the job name on the left. For example, Analyze (LANGUAGE).
-
Review the logging output from the actions in this workflow as they run.
-
After a scan completes, you can view alerts from a completed scan. For more information, see "Managing {% data variables.product.prodname_code_scanning %} alerts for your repository."
{% note %}
After you commit the workflow file or create a pull request, {% data variables.product.prodname_code_scanning %} will analyze your code according to the frequency you specified in your workflow file. If you created a pull request, {% data variables.product.prodname_code_scanning %} will only analyze the code on the pull request's topic branch until you merge the pull request into the default branch of the repository.
{% endnote %}
Understanding the pull request checks
Each {% data variables.product.prodname_code_scanning %} workflow you enable 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 {% data variables.product.prodname_code_scanning %} analysis checks take the form: "TOOL NAME / JOB NAME (TRIGGER)." For example, for {% data variables.product.prodname_codeql %}, analysis of C++ code has the entry "{% data variables.product.prodname_codeql %} / Analyze (cpp) (pull_request)." You can click Details on a {% data variables.product.prodname_code_scanning %} analysis entry to see logging data. This allows you to debug a problem if the analysis job failed. For example, for {% data variables.product.prodname_code_scanning %} analysis of compiled languages, this can happen if the action can't build the code.
When the {% data variables.product.prodname_code_scanning %} jobs complete, {% data variables.product.prodname_dotcom %} works out whether any alerts were added by the pull request and adds the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" entry to the list of checks. After {% data variables.product.prodname_code_scanning %} 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 {% data variables.product.prodname_code_scanning %} to the repository, you will initially see a "Missing analysis" message when you click Details on the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" check.
Reasons for the "missing analysis" message
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 "Missing analysis for base commit SHA-HASH" 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 the right of "Code scanning", click Set up code scanning.
The solution in this situation is to add the name of the base branch to the
on:pushandon:pull_requestspecification 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 %}.
Дальнейшие шаги
After enabling {% data variables.product.prodname_code_scanning %}, and allowing its actions to complete, you can:
- You can customize how {% data variables.product.prodname_code_scanning %} scans the code in your repository. For more information, see "Managing {% data variables.product.prodname_code_scanning %} alerts for your repository."
- You can view the run status of {% data variables.product.prodname_code_scanning %} and get notifications for completed runs. For more information, see "Managing a workflow run" and "Configuring notifications."
- Set up notifications for completed runs. For more information, see "Configuring notifications."
- Investigate any problems that occur with the initial setup of {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}. For more information, see "Troubleshooting the {% data variables.product.prodname_codeql %} workflow."
- Customize how {% data variables.product.prodname_code_scanning %} scans the code in your repository. For more information, see "Configuring {% data variables.product.prodname_code_scanning %}."





