Nota: No se puede acceder a las insignias de flujo de trabajo desde el exterior hacia un repositorio privado, así que no tendrás que embeberlas ni enlazarlas desde un sitio externo.
Una insignia de estado muestra si un flujo de trabajo falla o pasa actualmente. Un lugar común para agregar una insignia de estado es el archivo README.md de tu repositorio, pero puedes agregarlo a cualquier página web que quieras. Predeterminadamente, las insignias muestran el estado de tu rama predeterminada. También puedes mostrar el estado de la ejecución de un flujo de trabajo para una rama o evento específicos utilizando los parámetros de query branch y event en la URL.
Para agregar una insignia de estado de flujo de trabajo a tu archivo README.md, primero encuentra la URL de la insignia de estado que te gustaría mostrar. Luego, puedes utilizar lenguaje de marcado para mostrar la insignia como imagen en tu archivo README.md. Para obtener más información sobre el marcado de imagen en el lenguaje de marcado, consulta la sección "Escritura básica y sintaxis de formato".
Usar el nombre de archivo del flujo de trabajo
Puedes compilar la URL para una insignia de estado de flujo de trabajo utilizando el nombre del archivo de flujo de trabajo:
https://github.com/<OWNER>/<REPOSITORY>/actions/workflows/<WORKFLOW_FILE>/badge.svg
Para mostrar la insignia de estado de flujo de trabajo en tu archivo README.md, utiliza el lenguaje de marcado para embeber imágenes. Para obtener más información sobre el marcado de imagen en el lenguaje de marcado, consulta la sección "Escritura básica y sintaxis de formato".
Por ejemplo, agrega el siguiente lenguaje de marcado a tu archivo README.md para agregar una insignia de estado para un flujo de trabajo con la ruta de archivo .github/workflows/main.yml. El OWNER del repositorio es la organización github y el nombre del REPOSITORY es docs.
Utilizar el parámetro branch
Para mostrar el estado de una ejecución de flujo de trabajo para una rama específica, agrega ?branch=<BRANCH_NAME> al final de la URL de la insignia de estado.
Por ejemplo, agrega el siguiente lenguaje de marcado a tu archivo README.md para mostrar una insignia de estado para una rama con el nombre feature-1.
Utilizar el parámetro event
Para mostrar el estado de las ejecuciones de flujo de trabajo que se activan con el evento push, agrega ?event=push al final de la URL de la insignia de estado.
Por ejemplo, agrega el siguiente lenguaje de marcado a tu archivo README.md para mostrar la insignia con el estado de las ejecuciones de flujo de trabajo que activa el evento push, lo cual te mostrará el estado de la compilación para el estado actual de dicha rama.
