Mettre en cache les dépendances pour accélérer les compilations

La plupart du temps de CI est consacrée au téléchargement et à l’installation des mêmes dépendances à chaque exécution. La mise en cache les stocke entre les exécutions afin que les compilations suivantes réutilisent le travail déjà effectué, ce qui réduit souvent considérablement la durée de la chaîne CI/CD.

GitHub fournit actions/cache. Vous lui indiquez un chemin à mettre en cache et une clé qui identifie l’entrée du cache. En cas de correspondance, le chemin est restauré ; sinon, il est enregistré à la fin de la tâche.

La clé ne doit changer que lorsque le contenu mis en cache doit changer. Hacher le fichier de verrouillage est idéal : un nouveau fichier de verrouillage signifie de nouvelles dépendances, donc une nouvelle entrée de cache est créée.

restore-keys fournit des préfixes de repli. Si la clé exacte ne correspond pas, l’action restaure le cache le plus récent dont la clé commence par un préfixe, ce qui permet un démarrage partiellement préparé.

Lorsqu’une clé correspond exactement, vous obtenez une correspondance dans le cache et le chemin est restauré. En l’absence de correspondance, la tâche s’exécute normalement et le cache est enregistré à la fin avec la clé principale, afin d’être prêt pour la prochaine fois.

Les actions de configuration des langages intègrent la mise en cache. Pour Node, setup-node avec cache: npm gère le cache des dépendances pour vous ; aucune étape de mise en cache distincte n’est nécessaire.

Mettez en cache les répertoires de téléchargement du gestionnaire de paquets, et non le répertoire installé node_modules lorsque c’est possible, car les caches de téléchargement sont portables et l’étape d’installation vérifie toujours l’intégrité.

• Node : ~/.npm
• Python : cache de pip
• Java : ~/.m2 ou caches de Gradle

Les caches sont associés à une branche, avec un repli sur la branche par défaut, et leur taille est limitée pour chaque dépôt. Les caches inutilisés sont supprimés au fil du temps ; concevez donc des clés qui évoluent proprement.

Si votre clé ne change jamais, vous risquez de servir des dépendances obsolètes. Associez toujours la clé au hachage du fichier de verrouillage afin que les mises à jour invalident automatiquement le cache.

Dans les compilations matricielles couvrant plusieurs systèmes d’exploitation ou versions, incluez runner.os et la version dans la clé afin que chaque variante dispose de son propre cache correct, sans conflit.

Comparez la durée des tâches avant et après la mise en cache, et surveillez l’indicateur de correspondance dans les journaux. Un taux de correspondance constamment faible indique que la clé change trop souvent.

Vérifiez votre compréhension de la mise en cache des dépendances.

Vous avez accéléré la CI grâce à la mise en cache des dépendances : l’action actions/cache avec une clé fondée sur le hachage du fichier de verrouillage et un repli restore-keys, la mise en cache intégrée aux actions de configuration, le choix des éléments à mettre en cache, l’inclusion du système d’exploitation et de la version dans les clés matricielles, et l’évitement des caches obsolètes en associant la clé au fichier de verrouillage.