Nota: No se puede acceder externamente a los distintivos de flujo de trabajo de un repositorio privado, por lo que no podrás insertarlos en un sitio externo ni vincularlos desde ellos.
Una insignia de estado muestra si un flujo de trabajo falla o pasa actualmente. Un lugar común para agregar un distintivo de estado es el archivo README.md del repositorio, pero puede agregarlo a la página web que quiera. Predeterminadamente, las insignias muestran el estado de tu rama predeterminada. Si no hay ninguna ejecución de flujo de trabajo en la rama predeterminada, se mostrará el estado de la ejecución más reciente en todas las ramas. Puede mostrar el estado de la ejecución de un flujo de trabajo para una rama o evento específicos mediante los parámetros de consulta branch y event en la URL.
Para agregar un distintivo de estado del flujo de trabajo a tu archivo README.md, primero debes buscar la dirección URL del distintivo de estado que quieres mostrar. Luego, puedes usar Markdown para mostrar el distintivo como imagen en tu archivo README.md. Para más información sobre el marcado de imágenes en Markdown, consulta "Sintaxis de escritura y formato básicos".
Usar el nombre de archivo del flujo de trabajo
Para crear la dirección URL del distintivo de estado de un flujo de trabajo, puedes usar el nombre del archivo de flujo de trabajo:
https://github.com/OWNER/REPOSITORY/actions/workflows/WORKFLOW-FILE/badge.svg
Para mostrar el distintivo de estado del flujo de trabajo en tu archivo README.md, usa el marcado Markdown para insertar imágenes. Para más información sobre el marcado de imágenes en Markdown, consulta "Sintaxis de escritura y formato básicos".
Por ejemplo, agrega el Markdown siguiente a tu archivo README.md para agregar un distintivo de estado de un flujo de trabajo con la ruta de acceso al archivo .github/workflows/main.yml. En el repositorio, OWNER es la organización github y el nombre REPOSITORY es docs.
Uso del parámetro branch
Para mostrar el estado de una ejecución de flujo para una rama específica, agrega ?branch=BRANCH-NAME al final de la dirección URL al distintivo de estado.
Por ejemplo, agrega el Markdown siguiente al archivo README.md para mostrar un distintivo de estado para una rama con el nombre feature-1.
Uso del parámetro event
Si quieres mostrar el estado de las ejecuciones del flujo de trabajo que desencadenó el evento push, agrega ?event=push al final de la dirección URL del distintivo de estado.
Por ejemplo, agrega el Markdown siguiente a tu archivo README.md para mostrar un distintivo con el estado de las ejecuciones del flujo de trabajo que desencadenó el evento push, con lo que se mostrará el estado de la compilación del estado actual de dicha rama.
