Creación de un Workflow File con GitHub Actions

Resumen

¿Cómo crear un archivo Workflow en GitHub Actions?

GitHub Actions es una herramienta poderosa para la automatización de procesos. Entre estos, está la creación de workflows que permiten ejecutar automáticamente scripts al ocurrir ciertos eventos en el repositorio. En este contenido, te ayudaré a realizar tu primer archivo Workflow en GitHub Actions usando tu lenguaje de programación favorito. Empecemos viendo cómo funcionaría este Workflow y qué pasos debes seguir.

¿Cómo comenzar con un archivo de código simple?

Vamos a crear un archivo de script en Python llamado holamundo.py. Este es simple y tiene la tarea de saludar al usuario obteniéndolo de la variable de entorno username. Aquí te dejo un ejemplo del código:

import os

def main():
    nombre = os.getenv('USERNAME', 'usuario')
    print(f"Hola {nombre} desde GitHub")

if __name__ == "__main__":
    main()

Este script importará la librería os, usará la función getenv para obtener el nombre de usuario y luego lo imprimirá con un saludo amigable.

¿Cómo estructurar el archivo YAML para el Workflow?

En la creación del Workflow File, es crucial seguir una estructura específica con ciertas etiquetas clave. El archivo que manejará nuestro Workflow se llamará holamundo.yml. A continuación, veremos cómo puedes configurarlo paso a paso:

Etiquetas importantes del archivo YAML

name: Sirve para identificar el Workflow.
```
name: Aprendiendo GitHub Actions
```
- Ayuda a diferenciar varios workflows en un mismo repositorio.
run-name: Define un nombre amigable para cada ejecución del Workflow.
```
run-name: Estoy Aprendiendo GitHub Actions
```
- Esto permite identificar rápidamente ejecuciones específicas.
on: Especifica los eventos que activarán el Workflow.
```
on: [push]
```

jobs: Agrupa todos los trabajos que realizarán los steps en el Workflow.

jobs:
  holamundo:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Definir variable de entorno
        run: echo "USERNAME=${{ github.actor }}" >> $GITHUB_ENV
      - name: Correr script
        run: python holamundo.py

¿Cómo verificar la ejecución del Workflow en GitHub?

Cuando el Workflow file está correctamente configurado, cada vez que se haga push al repositorio, el Workflow se ejecutará. Puedes verificar la ejecución accediendo a la pestaña "Actions" en tu repositorio de GitHub. Ahí encontrarás el workflow Aprendiendo GitHub Actions, y podrás revisar cada uno de los jobs y sus logs correspondientes.

¿Cuándo utilizar ciertas acciones y variables de entorno?

actions/checkout: Se utiliza para clonar el repositorio y todos sus archivos dentro de la máquina virtual donde el Workflow se ejecuta.
Variables de entorno: Permiten compartir información importante entre los steps del mismo job. Por ejemplo, importar el nombre de usuario usando github.actor.

¿Cómo garantizar que GitHub reconozca el Workflow?

Es crucial respetar estrictamente la nomenclatura de los archivos Workflow, incluyendo nombres y extensiones como .yml, sin caracteres o formatos incorrectos. De esta forma, GitHub reconocerá el archivo y habilitará los retos o ejecuciones futuras correctamente.

Con todo esto, tienes las herramientas necesarias para iniciar tu camino con GitHub Actions y la automatización del flujo de trabajo. ¡Es hora de que crees tus propios workflows y saques el máximo provecho de lo que GitHub ofrece, explorando, colaborando y compartiendo tu aprendizaje con otros en la comunidad!