About the tool status page

The página de status da ferramenta provides visibility into the health and performance of code scanning tools in your repository.

Quem pode usar esse recurso?

Usuários com com acesso para gravação

O Code scanning está disponível para os seguintes tipos de repositório:

  • Repositórios públicos no GitHub.com
  • Repositórios de propriedade da organização em GitHub Team, GitHub Enterprise Cloudou GitHub Enterprise Server, com GitHub Code Security habilitados.

Neste artigo

Observação

O administrador do site precisa habilitar a code scanning antes que você possa usar esse recurso. Para saber mais, confira Como configurar a verificação de código do seu dispositivo.

Talvez você não consiga habilitar ou desabilitar o code scanning se um proprietário da empresa tiver definido uma política de GitHub Code Security no nível da empresa. Para saber mais, confira Como impor políticas para segurança e análise de código na empresa.

What is the página de status da ferramenta?

The página de status da ferramenta 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.

Observação

The página de status da ferramenta shows tool status at the repository level for the default branch only, not at the organization level.

Tool status indicators

The página de status da ferramenta 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 página de status da ferramenta 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 Sobre a varredura de código com CodeQL.

Compiled languages

The página de status da ferramenta reports files present before running autobuild or manual build steps. Files generated during the build process are not shown. See Verificação de código do CodeQL para linguagens compiladas.

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:

Observação

If you set up both advanced setup and default setup, the página de status da ferramenta only shows default setup.

Troubleshooting features

The página de status da ferramenta 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