You decide how you generate Varredura de código alerts, and which tools you 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."
||Opções para gerar alertas|
|CodeQL||Usar GitHub Actions (consulte "Habilitar Varredura de código usando ações") ou usar o Executor do CodeQL em um sistema contínuo de integração contínua (CI) de terceiros (consulte "Varrendo o código em execução no seu sistema de CI").|
|Third‑party||Usar GitHub Actions (consulte "Habilitar Varredura de código usando ações") ou geradas externamente e subidas em GitHub (consulte "Fazer upload de um arquivo SARIF em GitHub").|
Using actions to run Varredura de código will use minutes. For more information, see "About billing for GitHub Actions."
No GitHub, navegue até a página principal do repositório.
No seu nome de repositório, clique em Segurança.
To the right of "Varredura de código", click Set up Varredura de código.
Under "Get started with Varredura de código", click Set up this workflow on the Fluxo de trabalho de análise do CodeQL or on a third-party workflow.
To customize how Varredura de código scans your code, edit the workflow.
Generally you can commit the Fluxo de trabalho de análise do 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 Varredura de código."
Use the Start commit drop-down, and 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.
In the default Fluxo de trabalho de análise do CodeQL, Varredura de código 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, Varredura de código will now commence.
After enabling Varredura de código for your repository, you can watch the output of the actions as they run.
No nome do seu repositório, clique em Ações.
You'll see a list that includes an entry for running the Varredura de código workflow.
Click the entry for the Varredura de código 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.
Once all jobs are complete, you can view the details of any Varredura de código alerts that were identified. For more information, see "Managing Varredura de código alerts for your repository."
Note: If you raised a pull request to add the Varredura de código workflow to the repository, alerts from that pull request aren't displayed directly on the Varredura de código 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 Varredura de código page.
Each Varredura de código 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 Varredura de código 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 Varredura de código analysis entry to see logging data. This allows you to debug a problem if the analysis job failed. For example, for Varredura de código analysis of compiled languages, this can happen if the action can't build the code.
When the Varredura de código jobs complete, GitHub works out whether any alerts were added by the pull request and adds the "Varredura de código results / TOOL NAME" entry to the list of checks. After Varredura de código 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 Varredura de código to the repository, you will initially see a "Missing analysis" message when you click Details on the "Varredura de código results / TOOL NAME" check.
After Varredura de código 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 Varredura de código 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 Varredura de código 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 check whether a branch has been scanned, go to the Varredura de código 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:pull_requestspecification in the Varredura de código 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 Varredura de código.
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 Varredura de código on this latest commit, then push a change to the pull request to retrigger Varredura de código.
After enabling Varredura de código, and allowing its actions to complete, you can:
- View all of the Varredura de código alerts generated for this repository. For more information, see "Managing Varredura de código alerts for your repository."
- View any alerts generated for a pull request submitted after you enabled Varredura de código. For more information, see "Triaging Varredura de código alerts in pull requests."
- Set up notifications for completed runs. For more information, see "Configuring notifications."
- Investigate any problems that occur with the initial setup of CodeQL Varredura de código. For more information, see "Troubleshooting the CodeQL workflow."
- Customize how Varredura de código scans the code in your repository. For more information, see "Configuring Varredura de código."