Gestion et installation des dépendances en CI/CD¶
Les stages de cette série
Chaque page de la catégorie CI/CD réutilise les mêmes noms de stages, dans cet ordre. Tu peux ainsi assembler les jobs des différentes pages dans un seul et même .gitlab-ci.yml.
stages:
- install # dépendances
- lint # analyse statique
- test # tests unitaires, d'intégration, cross-browser, visuels
- quality # Quality Gate SonarQube (après les tests, pour la couverture)
- build # image Docker
- security # secrets, SCA, scan d'image (après le build)
- package # Helm
- deploy # déploiement
- nightly # pipelines planifiés : E2E, load testing, pentests
Un job qui ne dépend d'aucun artefact peut démarrer immédiatement avec needs: [] ; un job qui dépend d'un autre le déclare avec needs:.
C'est la première étape de ta CI/CD. Ici je vais te montrer comment installer les dependances nécessaire à ton projet pour builder.
Exemple avec NodeJS¶
Mais pourquoi faire ?¶
Je te montre un exemple ici sous NodeJS. On souhaite installer les dependances de tes packages NPM. Tu en as besoin initialement pour développer en local tes features, lancer ton serveur en mode dév pour développer des features (te permettant des fonctionnalités comme le hot-reload), etc.
Question
Mais pourquoi j'en aurais besoin d'avoir mon dossier de node_modules présent en CI/CD ?
Tot ou tard tu vas souhaiter build ton projet. Que cela soit une application que tu souhaites distribuer sous forme d'image Docker pour un Helm Chart, ou encore une simple lib NPM. Il va te falloir passer par un bundler, comme par exemple esBuild, Webpack, Vite, Parcel, Rollup, etc. Et pour cela, il te faudra forcement d'installé en local tes dependances.
Tu peux egalement en avoir besoin pour lancer tes scripts de ton package.json, que cela soit pour le build, testing, etc. en pipeline. Il te faudra donc tes modules d'installé encore une fois en local.
Exemple de code¶
- On crée un nouveau job
install-depsappartenant au stageinstall - Etant a la racine, on lance
npm ci. C'est l'équivalent denpm install, mais en plus rapide et donc optimisé pour les environnements CI/CD. En effet il ne va pas s'embêter à re-calculer tout l'arbre des dépendances et appliquer comme tel est spécifié dans lepackage-lock.json - On met en
cachele cache de npm (.npm/), avec une clé calculée à partir dupackage-lock.json. Tant que le lockfile ne change pas,npm ci --cache .npm --prefer-offlinepioche les paquets dans ce cache au lieu de les retélécharger depuis le registry
Tip
Etant donnée que tu risques d'avoir besoin du dossier node_modules contenant tout tes modules NPM dans d'autres jobs, et afin de les installer une seule et unique fois dans toute ta pipeline, cela te fera un gain de temps 😎 On utilise la prop artifacts
Cache ou artifacts ?
Le cache accélère un job d'un pipeline à l'autre, sans garantie d'être disponible : on y met le cache npm. Les artifacts transmettent de façon fiable des fichiers aux jobs suivants du même pipeline : on y met node_modules/. Ne mets pas node_modules/ en cache : npm ci le supprime avant chaque installation.
Pour aller plus loin¶
- Analyse statique et linting : le stage
lint, dont les jobs récupèrentnode_modulesvianeeds: [install-deps] - Tests unitaires avec Jest : le stage
test - Slides : premier workflow avec Node.js et son TP : premier pipeline CI/CD avec Node.js