Almacenamiento en caché de dependencias para acelerar la ejecución

¿Ha notado que su flujo de trabajo vuelve a descargar las mismas dependencias cada vez? ¡Eso ralentiza todo!

El almacenamiento en caché de GitHub Actions le permite guardar y reutilizar archivos de ejecuciones anteriores. Esto acelera considerablemente las ejecuciones posteriores del flujo de trabajo.

GitHub proporciona una acción especial llamada actions/cache@v3. Esta acción está diseñada para guardar y restaurar archivos con el fin de acelerar sus flujos de trabajo.

Es inteligente: comprueba si la caché ya existe antes de intentar restaurarla y la guarda si no existe.

Dos parámetros fundamentales de actions/cache son key y path:

• key: cadena única que identifica su caché. Si se encuentra una caché con esta clave, se restaura.
• path: rutas de archivos o directorios que desea almacenar en caché. Esto indica a la acción *qué* debe guardar o restaurar.

La clave suele incluir un hash de los archivos de dependencias para garantizar que la caché se invalide cuando cambien las dependencias.

Almacenemos en caché node_modules para un proyecto de Node.js. Usaremos hashFiles para crear una clave dinámica basada en package-lock.json.

Pruebe a ejecutar este sencillo fragmento de flujo de trabajo:

¿Qué ocurre si su key exacta no coincide con ninguna caché? ¡Ahí es donde restore-keys resulta útil!

restore-keys proporciona una lista de claves alternativas que se pueden buscar. Si no se encuentra la clave principal (por ejemplo, npm-${{ hashFiles(...) }}), GitHub Actions intenta encontrar una caché utilizando las claves de restore-keys en orden.

En nuestro ejemplo, npm- intenta encontrar cualquier caché que empiece por "npm-", lo que resulta útil si solo han cambiado versiones menores de las dependencias.

¡El almacenamiento en caché no es exclusivo de Node.js! Puede aplicar el mismo principio a otros lenguajes, como Python. Aquí almacenamos en caché el entorno virtual de Python y la caché de pip.

En este caso, la clave utiliza hashFiles('requirements.txt'), y la ruta apunta al entorno virtual y al directorio de caché de pip.

Una caché solo resulta útil si está suficientemente actualizada. Si cambian sus dependencias, la caché también debería cambiar.

La caché se invalida automáticamente si cambia su key principal (por ejemplo, npm-${{ hashFiles('package-lock.json') }}). Si se actualiza package-lock.json, cambia el hash y se crea una nueva caché.

También puede forzar la reconstrucción de una caché cambiando manualmente la clave (por ejemplo, añadiendo un sufijo de versión como npm-v2-${{ hashFiles(...) }}).

Es conveniente saber cómo funciona el almacenamiento en caché internamente:

• Ámbito: las cachés tienen un ámbito por repositorio y por rama. Una caché de la rama main no se utilizará en una rama de funcionalidad, a menos que configure explícitamente lookup-path.
• Límite de tamaño: cada caché puede tener un tamaño máximo de 10 GB.
• Retención: las cachés se conservan durante 7 días después del último acceso. Las cachés antiguas que no se utilizan se eliminan automáticamente.

Para aprovechar al máximo el almacenamiento en caché:

• Use hashFiles: vincule siempre la clave de la caché a los archivos de manifiesto de dependencias (por ejemplo, package-lock.json y requirements.txt).
• Sea específico con path: almacene en caché únicamente lo necesario (por ejemplo, node_modules y ~/.cache/pip).
• Use restore-keys: proporcione alternativas para mejorar la tasa de aciertos de la caché.
• Evite almacenar datos volátiles en caché: no almacene archivos que cambien con frecuencia o que sean muy grandes y únicos para cada ejecución (por ejemplo, artefactos de compilación destinados a la implementación).

Tiene un proyecto de Java que utiliza Maven. Sus dependencias se definen en pom.xml, y Maven suele almacenar los archivos JAR descargados en ~/.m2/repository.

¿Qué configuración de caché garantiza mejor que las dependencias de Maven se almacenen en caché y se invaliden correctamente cuando cambie pom.xml?

¡Excelente trabajo! Ha aprendido a implementar el almacenamiento en caché en GitHub Actions para acelerar considerablemente sus flujos de trabajo de CI/CD.

• La acción actions/cache es su herramienta.
• Use key y path para definir qué se debe almacenar en caché y cómo hacerlo.
• hashFiles crea claves dinámicas para una invalidación inteligente.
• restore-keys proporciona alternativas útiles.

Al almacenar las dependencias en caché de forma inteligente, ahorra tiempo de compilación y recursos computacionales, lo que hace que sus canalizaciones sean más eficientes.