メモ
この機能を使用するには、サイト管理者が code scanning を有効にする必要があります。 詳しくは、「アプライアンス用コードスキャンの構成」をご覧ください。
Enterprise の所有者が Enterprise レベルで GitHub Advanced Security ポリシーを設定している場合、code scanning を有効または無効にできない場合があります。 詳しくは、「エンタープライズのコード セキュリティと分析のためのポリシーの適用」をご覧ください。
What is the ツールの状態ページ?
The ツールの状態ページ shows information about all of your code scanning tools and is a good starting point for debugging problems when code scanning isn't working as expected.
メモ
The ツールの状態ページ shows tool status at the repository level for the default branch only, not at the organization level.
Tool status indicators
The ツールの状態ページ displays one of three statuses:
- All configurations are working: All tools are operating as expected
- Some configurations need attention: Some tools have warnings or non-critical issues
- Some configurations are not working: One or more tools have critical errors
What information is available
For all code scanning tools
- Configuration status and health
- Scan scheduling
- First and most recent scan times
- Rules used in scans
For integrated tools like CodeQL
In addition to the information listed above, the ツールの状態ページ for integrated tools provides the following details:
- File coverage percentages by programming language
- Configuration details for each setup type
- Specific error messages
- Downloadable CSV reports of analyzed files
- Downloadable lists of rules used and alert counts
How CodeQL defines scanned files
CodeQL reports a file as scanned if some lines of code in that file were processed.
Interpreted languages
- Default setup: Scanned files include all source code files for languages CodeQL can analyze
- Advanced setup: You can use
pathsandpaths-ignoreto define which files to scan. See CodeQL によるコード スキャンについて.
Compiled languages
The ツールの状態ページ reports files present before running autobuild or manual build steps. Files generated during the build process are not shown. See コンパイル済み言語の CodeQL コード スキャン.
Coverage calculation
File coverage percentages respect any files excluded by paths and paths-ignore configuration properties.
Understanding file coverage percentages
Use file coverage percentages to debug and improve your analysis:
- High percentage: Code scanning is working as expected for that language
- Low percentage: Investigate diagnostic output. See CodeQL によってスキャンされた行が予想よりも少ない
- Zero percentage: You may have code in languages not currently being analyzed. Update your setup to include these languages. See コード スキャン用の高度なセットアップのカスタマイズ
メモ
If you set up both advanced setup and default setup, the ツールの状態ページ only shows default setup.
Troubleshooting features
The ツールの状態ページ helps you troubleshoot issues through:
- Error messages: Explains why tools aren't performing as expected with suggested actions
- File coverage data: Shows which files and languages are being analyzed
- Configuration details: Displays information about each analysis run
- Downloadable reports: Provides CSV reports with detailed file and rule information