Skip to main content

About the tool status page

The página de estado de la herramienta provides visibility into the health and performance of code scanning tools in your repository.

¿Quién puede utilizar esta característica?

Usuarios con acceso de escritura

Code scanning está disponible para los tipos de repositorio siguientes:

  • Repositorios públicos en GitHub.com
  • Repositorios propiedad de la organización en GitHub Team, GitHub Enterprise Cloud, o GitHub Enterprise Server, con GitHub Code Security habilitados.

Nota:

El administrador del sitio debe habilitar code scanning antes de que puedas utilizar esta característica. Para más información, consulta Configuración la digitalización de código para el dispositivo.

Es posible que no puedas habilitar o deshabilitar code scanning si un propietario de una empresa ha establecido una directiva de GitHub Code Security en el nivel de la empresa. Para más información, consulta Aplicación de directivas de seguridad y análisis de código de la empresa.

What is the página de estado de la herramienta?

The página de estado de la herramienta 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.

Nota:

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

Tool status indicators

The página de estado de la herramienta 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 estado de la herramienta 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 Acerca del examen de código con CodeQL.

Compiled languages

The página de estado de la herramienta reports files present before running autobuild or manual build steps. Files generated during the build process are not shown. See Análisis de código de CodeQL para lenguajes compilados.

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:

Nota:

If you set up both advanced setup and default setup, the página de estado de la herramienta only shows default setup.

Troubleshooting features

The página de estado de la herramienta 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