About your 代码扫描 setup
You can use a variety of tools to set up 代码扫描 in your repository. For more information, see "Setting up 代码扫描 for a repository."
The log and diagnostic information available to you depends on the method you use for 代码扫描 in your repository. You can check the type of 代码扫描 you're using in the Security tab of your repository, by using the Tool drop-down menu in the alert list. For more information, see "Managing 代码扫描 alerts for your repository."
About analysis and diagnostic information
You can see analysis and diagnostic information for 代码扫描 run using CodeQL analysis on GitHub.
Analysis information is shown for the most recent analysis in a header at the top of the list of alerts. For more information, see "Managing code scanning alerts for your repository."
Diagnostic information is displayed in the Action workflow logs and consists of summary metrics and extractor diagnostics. For information about accessing 代码扫描 logs on GitHub, see "Viewing the logging output from 代码扫描" below.
If you're using the CodeQL CLI outside GitHub, you'll see diagnostic information in the output generated during database analysis. This information is also included in the SARIF results file you upload to GitHub with the 代码扫描 results.
For information about the CodeQL CLI, see "Running CodeQL CLI in your CI system."
About summary metrics
Summary metrics include:
- Lines of code in the codebase (used as a baseline), before creation and extraction of the CodeQL database
- Lines of code in the CodeQL database extracted from the code, including external libraries and auto-generated files
- Lines of code in the CodeQL database excluding auto-generated files and external libraries
About CodeQL source code extraction diagnostics
Extractor diagnostics only cover files that were seen during the analysis, metrics include:
- Number of files successfully analyzed
- Number of files that generated extractor errors during database creation
- Number of files that generated extractor warnings during database creation
Viewing the logging output from 代码扫描
This section applies to 代码扫描 run using GitHub Actions (CodeQL or third-party).
After setting up 代码扫描 for your repository, you can watch the output of the actions as they run.
-
在仓库名称下，单击 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.
-
Click the entry for the 代码扫描 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 代码扫描 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.
