Exploración de los resultados de calidad de código GitHub en su organización

Prerequisites

• Si su organización pertenece a una empresa, un propietario de empresa debe habilitar Code Quality para su organización. Consulte Permitir el uso de GitHub Code Quality en su empresa.
• La organización debe tener repositorios con Code Quality habilitado. Consulte Habilitar GitHub Code Quality.

Visualización de información de calidad del código para su organización

El panel de nivel de organización tiene dos pestañas:

• La pestaña Estado muestra una instantánea del estado actual del código de la organización.
• En la pestaña Tendencias se muestra cómo han cambiado los resultados abiertos durante un período de tiempo seleccionado, por lo que puede realizar un seguimiento del progreso e identificar repositorios que necesitan atención.

1. En GitHub, vaya a la página principal de la organización. Por ejemplo, desde https://github.com/settings/organizations.
2. Debajo del nombre de su organización, haga clic en la pestaña Security and quality.
3. En la sección "Insights" de la barra lateral, haga clic en Calidad del código.

Filtrado de datos del panel

Una barra de filtro en la parte superior del panel se aplica a las pestañas Estado y Tendencias . Puede filtrar por:

• Puntuación de confiabilidad
• Puntuación de mantenimiento
• Conclusiones estándar
• Conclusiones de IA
• Topic
• Equipo
• Visibilidad
• Cualquier propiedad personalizada definida para su organización

También puede ordenar los datos del panel mediante el control Ordenar en la misma barra de filtro.

Visualización del estado del código actual

En la pestaña Estado se muestra una instantánea del estado del código de la organización en este momento.

Interpretación del gráfico de distribución de puntuación

El gráfico de distribución de puntuación proporciona información general visual sobre el estado del código de la organización. Cada burbuja representa una colección de repositorios con las mismas puntuaciones de mantenimiento y confiabilidad.

• La posición de cada burbuja muestra el estado general de esos repositorios. Las burbujas más altas representan puntuaciones de mantenimiento más altas, mientras que las burbujas más a la derecha representan puntuaciones de confiabilidad más altas.
• El patrón de color y borde de una burbuja indica la gravedad de la puntuación más baja para esos repositorios. Por ejemplo, una burbuja con una puntuación "Deficiente" en cualquiera de las dos categorías siempre se muestra en rojo con borde discontinuo.
• El tamaño de cada burbuja representa el número de repositorios con esa combinación de puntuación determinada.

Para ver la puntuación de mantenimiento, la puntuación de confiabilidad y el número de repositorios representados por una burbuja determinada, mantenga el puntero sobre la burbuja.

Exploración de la tabla del repositorio

Debajo del gráfico de burbujas, hay una tabla que enumera todos los repositorios de la organización. Aquí puede ver los resultados de calidad del código, junto con información más detallada sobre esos hallazgos.

Puede ordenar la tabla del repositorio en orden ascendente o descendente para cualquier columna haciendo clic en el encabezado de columna.

Investigación de repositorios de puntuación baja

1. Para filtrar los datos del panel de los repositorios de menor rendimiento, en el gráfico de distribución de puntuación, haga clic en la burbuja con las puntuaciones combinadas más bajas.
2. Desplácese hacia abajo hasta la tabla del repositorio. De forma predeterminada, la tabla se ordena de la exploración del repositorio más reciente a la menos reciente, lo que le ayuda a priorizar los problemas de calidad actuales.
3. Opcionalmente, para priorizar los repositorios con el mayor número de CodeQL hallazgos, haga clic Conclusiones estándar dos veces.
4. Para ver el panel de nivel de repositorio de un repositorio específico, haga clic en el nombre del repositorio.

Seguimiento de tendencias de calidad a lo largo del tiempo

En la pestaña Tendencias se muestra cómo los resultados abiertos en los repositorios a los que tiene acceso y que coinciden con los filtros actuales han cambiado con el tiempo, por lo que puede indicar si el trabajo de calidad del código tiene un efecto y dónde centrar la atención a continuación.

1. En el panel de nivel de organización, haga clic en la pestaña Tendencias .
2. Use la lista desplegable Período para seleccionar un intervalo de tiempo: los últimos 7, 14 o 30 días.
3. Revise el gráfico "Hallazgos abiertos a lo largo del tiempo", que muestra el número total de hallazgos abiertos en los repositorios aplicables durante el periodo seleccionado.
4. De forma opcional, use los botones situados encima del gráfico para agrupar los datos por puntuación de estado o gravedad.
5. Pase el cursor sobre un punto del gráfico para ver el número de hallazgos abiertos de ese día.

Descripción de los datos de tendencias

Tenga en cuenta lo siguiente al interpretar el gráfico:

• El gráfico se basa en instantáneas diarias de los resultados abiertos. Si no se ejecutó ningún análisis en un día determinado, puede que no haya ningún punto de datos para ese día.

• Los datos históricos solo están disponibles desde cuando Code Quality se inician las instantáneas, por lo que el intervalo de tiempo disponible puede estar limitado inicialmente.

• El gráfico realiza un seguimiento del recuento total de hallazgos abiertos, no de hallazgos individuales que se abren o corrigen. Un cambio en el recuento no significa necesariamente que los desarrolladores corrigieron o introdujeron problemas.

• La habilitación Code Quality en repositorios adicionales puede aumentar el recuento de resultados que se muestra en el gráfico. Un aumento después de habilitar nuevos repositorios no significa necesariamente que la calidad del código disminuya.

• El gráfico realiza un seguimiento del recuento total de resultados abiertos de los repositorios en los que está filtrando actualmente. El recuento total incluye:

  • Nuevos hallazgos introducidos por cambios de código o cuando el análisis de calidad de código está habilitado en nuevos repositorios
  • Hallazgos fijos en el código o descartados por los usuarios

Identificación de repositorios que necesitan atención

Debajo del gráfico de tendencias, dos tablas le ayudarán a identificar qué repositorios necesitan atención durante el período de tiempo seleccionado:

• La mayoría de los repositorios mejorados enumeran los repositorios con la mayor disminución de los resultados abiertos durante el período de tiempo seleccionado.
• Los repositorios que necesitan mejoras enumeran los repositorios con el mayor aumento de los resultados abiertos durante el período de tiempo seleccionado.

Ambas tablas incluyen las siguientes columnas:

• Repositorio: el nombre del repositorio.
• Total de hallazgos abiertos: El número de hallazgos abiertos del repositorio al final del periodo seleccionado.
• Cambio neto: cómo ha cambiado el recuento de resultados abiertos del repositorio durante el período de tiempo seleccionado.
• Descartado: cuántas conclusiones se descartaron para el repositorio durante el período de tiempo seleccionado.

El número de hallazgos en un repositorio se ve afectado por los hallazgos que se corrigen y se descartan. Puede usar el panel de nivel de repositorio para confirmar lo que ha cambiado.

Para investigar un repositorio, haga clic en su nombre para abrir su panel de nivel Code Quality de repositorio, donde puede revisar los resultados individuales y realizar una acción de corrección.

Pasos siguientes

Para comprender la información de mantenimiento del código disponible en el panel de nivel de repositorio, consulte Análisis de los resultados de calidad del código para tu repositorio.

Si planea habilitar Code Quality en muchos repositorios, consulte Despliegue de GitHub Code Quality a gran escala.