Acerca de los flujos de trabajo reutilizables
En vez de copiar y pegar desde un flujo de trabajo hacia otro, puede hacer flujos de trabajo reutilizables. Tú y cualquiera que tenga acceso a un flujo de trabajo reutilizable pueden entonces llamarlo desde otro flujo.
El reutilizar flujos de trabajo evita la duplicación. Esto hace que los flujos de trabajo se puedan mantener más fácilmente y te permite crear flujos de trabajo nuevos más fácilmente compilando sobre el trabajo de los demás, tal como lo haces con las acciones. La reutilización de flujos de trabajo también promueve las mejores prácticas al ayudarte a utilizar los flujos de trabajo que están bien diseñados, que ya se han probado y cuya efectividad ya se comprobó. Tu organización puede crear una librería de flujos de trabajo reutilizables que puede mantenerse centralmente.
En el diagrama siguiente se muestra una ejecución de flujo de trabajo en curso que usa un flujo de trabajo reutilizable.
- Una vez que cada uno de los tres trabajos de compilación de la izquierda del diagrama se completa correctamente, se ejecuta un trabajo dependiente denominado "Implementar".
- El trabajo "Implementar" llama a un flujo de trabajo reutilizable que contiene otros tres trabajos: "Almacenamiento provisional", "Revisión" y "Producción".
- El job de despliegue "Production" solo se ejecuta después de que el job "Staging" se haya completado con éxito.
- Cuando un trabajo tiene como destino un entorno, la ejecución del flujo de trabajo muestra una barra de progreso en la que se puede ver el número de etapas del trabajo. En el diagrama siguiente, el trabajo "Producción" contiene ocho pasos, y se puede ver cómo se está procesando el paso 6.
- El utilizar un flujo de trabajo reutilizable para ejecutar jobs de despliegue te permite ejecutarlos para cada compilación sin duplicar el código en los flujos de trabajo.
A un flujo de trabajo que utiliza otro flujo de trabajo se le llama flujo de trabajo "llamante". El flujo de trabajo reutilizable es un flujo "llamado". Un flujo de trabajo llamante puede utilizar varios flujos de trabajo llamados. Cada flujo de trabajo llamado se referencia en una línea simple. El resultado es que el archivo de flujo de trabajo llamante podrá contener solo unas cuantas líneas de YAML, pero podría realizar una cantidad grande de tareas cuando se ejecute. Cuando reutilizas un flujo de trabajo, se utiliza todo el flujo de trabajo llamado justo como si fuera parte del flujo de trabajo llamante.
Si utilizas un flujo de trabajo desde un repositorio diferente, cualquier acción en el flujo de trabajo llamado se ejecutará como si fuera parte del llamante. Por ejemplo, si el flujo de trabajo al que se ha llamado usa actions/checkout, la acción comprueba el contenido del repositorio que hospeda el flujo de trabajo que ha iniciado la llamada y no el que la recibe.
Puede ver los flujos de trabajo reutilizados que se referencian en sus flujos de trabajo de GitHub Actions como dependencias en la gráfica de dependencias del repositorio que los contiene. Para obtener más información, consulte "Acerca del gráfico de dependencias".
Diferencias entre flujos de trabajo reutilizables y acciones compuestas
Los flujos de trabajo reutilizables y las acciones compuestas te ayudan a evitar la duplicación del contenido del flujo de trabajo. Mientras que los flujos de trabajo reutilizables permiten reutilizar un flujo de trabajo completo, con varios trabajos y pasos, las acciones compuestas combinan varios pasos que puede ejecutar en un único paso de trabajo, al igual que cualquier otra acción.
Ahora se compararán algunos aspectos de cada solución:
- Trabajos de flujo de trabajo: las acciones compuestas contienen una serie de pasos, que se ejecutan como un solo paso dentro del flujo de trabajo del autor de la llamada. A diferencia de los flujos de trabajo reutilizables, no pueden contener trabajos.
- Registro: cuando se ejecuta una acción compuesta, el registro mostrará solo el paso del flujo de trabajo del autor de la llamada que ejecutó la acción compuesta, no los pasos individuales dentro de la acción compuesta. Con los flujos de trabajo reutilizables, cada trabajo y paso se registra por separado.
- Especificación de ejecutores: los flujos de trabajo reutilizables contienen uno o varios trabajos. Al igual que con todos los trabajos de flujos de trabajo, los trabajos de un flujo de trabajo reutilizable especifican el tipo de máquina en el que se ejecutará el trabajo. Por lo tanto, si los pasos deben ejecutarse en un tipo de máquina que podría ser diferente de la máquina elegida para el trabajo del flujo de trabajo que realiza la llamada, debe usar un flujo de trabajo reutilizable, no una acción compuesta.
- Pasar la salida a los pasos: una acción compuesta se ejecuta como un paso dentro de un trabajo de flujo de trabajo y puede tener varios pasos antes o después del paso que ejecuta la acción compuesta. Los flujos de trabajo reutilizables se llaman directamente dentro de un trabajo y no desde dentro de un paso de trabajo. No puede agregar pasos a un trabajo después de llamar a un flujo de trabajo reutilizable, por lo que no puede usar
GITHUB_ENVpara pasar valores a pasos de trabajo posteriores en el flujo de trabajo del autor de la llamada.
Diferencias clave entre flujos de trabajo reutilizables y acciones compuestas
| Flujos de trabajo reutilizables | Acciones compuestas |
|---|---|
| Un archivo YAML, muy similar a cualquier archivo de flujo de trabajo estándar | Una acción que contiene un conjunto de pasos de flujo de trabajo |
Cada flujo de trabajo reutilizable es un único archivo en el directorio .github/workflows de un repositorio. | Cada acción compuesta es un repositorio independiente, o un directorio, que contiene un archivo action.yml y, opcionalmente, otros archivos |
| Se llama haciendo referencia a un archivo YAML específico. | Se llama haciendo referencia a un repositorio o directorio en el que se define la acción. |
| Se llama directamente dentro de un trabajo, no desde un paso | Ejecutar como un paso dentro de un trabajo |
| Puede contener varios trabajos | No contiene trabajos |
| Cada paso se registra en tiempo real | Se registra como un paso incluso si contiene varios pasos |
| Puede conectar un máximo de cuatro niveles de flujos de trabajo. | Se puede anidar para tener hasta 10 acciones compuestas en un flujo de trabajo. |
| Puede usar secretos | No puede usar secretos |
Flujos de trabajo reutilizables y plantillas de flujo de trabajo
Las plantillas de flujo de trabajo permiten que todos los usuarios de la organización que tengan permiso para crear flujos de trabajo lo hagan de forma más fácil y rápida. Cuando los usuarios crean un flujo de trabajo, pueden elegir una plantilla de flujo de trabajo y parte o todo el trabajo de escribir el flujo de trabajo se hará automáticamente. Dentro de una plantilla de flujo de trabajo, también puede hacer referencia a flujos de trabajo reutilizables para hacer más fácil que los usuarios se beneficien de reutilizar el código de flujo de trabajo que se administra centralmente.
Si utiliza un SHA de confirmación cuando hace referencia al flujo de trabajo reutilizable, puede garantizar que todo aquel que reutilice ese flujo de trabajo siempre estará utilizando el mismo código de YAML. Sin embargo, si referencias un flujo de trabajo reutilizable mediante una etiqueta o rama, asegúrate de que puedas confiar en esa versión del flujo de trabajo. Para más información, consulta Referencia de uso seguro.
GitHub ofrece plantillas de flujo de trabajo para varios lenguajes y herramientas. Cuando configuras flujos de trabajo en tu repositorio, GitHub analiza el código en tu repositorio y recomienda flujos de trabajo en función del lenguaje y el marco del repositorio. Por ejemplo, si usas Node.js, GitHub sugerirá una plantilla de flujo de trabajo que instala los paquetes de Node.js y ejecuta las pruebas. Puede buscar y filtrar para buscar las plantillas de flujo de trabajo pertinentes.
GitHub proporciona plantillas de flujo de trabajo listas para usar para las siguientes categorías generales:
-
Implementación (CD) . Para más información, consulta Continuous deployment.
-
Integración continua (CI) . Para más información, consulta Integración continua.
-
Automatización. Las plantillas de flujo de trabajo de automatización ofrecen soluciones para automatizar flujos de trabajo, como evaluar las solicitudes de incorporación de cambios y aplicar una etiqueta basada en las rutas modificadas en la solicitud de incorporación de cambios, o bien saludar a los usuarios que colaboran por primera vez en el repositorio.
Puede utilizar plantillas de flujo de trabajo como punto de partida para crear el flujo de trabajo personalizado, o bien utilizarlas tal cual. Puede examinar la lista completa de plantillas de flujo de trabajo en el repositorio actions/starter-workflows.
Para más información, consulta Creación de plantillas de flujo de trabajo para la organización.
Pasos siguientes
Para empezar a reutilizar tus flujos de trabajo, consulta Reutilización de flujos de trabajo.
Para buscar información sobre las complejidades de la reutilización de flujos de trabajo, consulta Referencia de flujos de trabajo reutilizables.