About the tool status page

The 도구 상태 페이지 provides visibility into the health and performance of code scanning tools in your repository.

누가 이 기능을 사용할 수 있나요?

쓰기 권한이 있는 사용자

Code scanning은 다음 리포지토리 유형에서 사용할 수 있습니다.

  • GitHub.com에 대한 퍼블릭 리포지토리
  • GitHub Team, GitHub Enterprise Cloud 또는 GitHub Enterprise Server에 대한 조직 소유의 리포지토리로, GitHub Code Security 가 활성화되어 있습니다.

이 문서의 내용

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 paths and paths-ignore to 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:

참고 항목

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

Further reading