Saltar al contenido

Añada una insignia de velocidad de CI a su README

Última actualización

Un distintivo de velocidad de CI muestra el tiempo mediano de las ejecuciones recientes de GitHub Actions de su repositorio, directamente en su README. Los colaboradores ven de un vistazo cuánto tendrán que esperar las comprobaciones, y una cifra baja es una señal discreta de que el proyecto está bien mantenido. Esta página explica cómo añadir uno, qué significa el número y las normas de privacidad que lo rigen.

El distintivo

Para un repositorio que ejecuta su CI en compiler.dev, añada esta línea a README.md, sustituyendo OWNER/REPO:

[![CI speed](https://compiler.dev/badge/OWNER/REPO.svg)](https://compiler.dev/benchmarks)

Se muestra como un pequeño distintivo, por ejemplo CI | 2m 14s · compiler.dev. GitHub almacena en caché las imágenes del README mediante su proxy camo; el distintivo permite una caché de 10 minutos, de modo que la cifra sigue de cerca sus ejecuciones.

Qué significa el número

El tiempo es la mediana de sus últimas 20 ejecuciones de workflow de los últimos 30 días, medido desde que se encola el primer job hasta que termina el último. Es el tiempo que un colaborador espera realmente, incluido el tiempo en cola, y no la suma de los minutos de los jobs. Solo cuentan las ejecuciones cuyos jobs terminaron en máquinas de compiler.dev, de modo que una ejecución que recurrió a sus propios runners no distorsiona la cifra.

Se usa la mediana en lugar de la media para que una sola ejecución bloqueada o cancelada no haga saltar el distintivo.

Privacidad

El distintivo solo muestra un tiempo para repositorios públicos. Antes de mostrar un número, compiler.dev consulta la API pública de GitHub; para un repositorio privado, o uno que GitHub no conoce, el distintivo solo dice «con tecnología de compiler.dev». Por tanto, publicar en algún lugar la URL del distintivo de un repositorio privado no revela nada sobre él, ni siquiera si usa compiler.dev.

¿Aún no usa compiler.dev?

El distintivo necesita los tiempos de ejecución, que compiler.dev registra para los jobs que ejecuta. Aun así, puede medir su CI hoy con la acción gratuita CI Timing Report, que añade una tabla de tiempos job por job a cada resumen de ejecución. Para reducir el número, empiece por cómo acelerar GitHub Actions y la calculadora de shards de tests.

Preguntas frecuentes

¿Por qué mi distintivo dice «con tecnología de compiler.dev» en lugar de un tiempo?

O bien el repositorio es privado, o no tiene ejecuciones completadas en compiler.dev en los últimos 30 días, o no se pudo contactar con la API de GitHub. Compruebe que el propietario y el nombre del repositorio en la URL estén escritos exactamente igual que en GitHub.

¿Con qué frecuencia se actualiza el distintivo?

Los tiempos de ejecución se recalculan como máximo cada 10 minutos, y el distintivo permite que GitHub lo almacene en caché durante 10 minutos, por lo que las nuevas ejecuciones aparecen en unos 20 minutos.

¿Puedo usar el distintivo solo para un workflow?

Todavía no. El distintivo abarca todas las ejecuciones de workflow del repositorio que se ejecutaron en compiler.dev. Si necesita cifras por workflow, la acción CI Timing Report las muestra en el resumen de cada ejecución.

Ejecute este workflow en compiler.dev Sin tarjeta · 200 minutos gratuitos

Pruébelo gratis