TP : Votre premier pipeline CI/CD avec Node.js¶
Ce TP a pour objectif de vous faire pratiquer la mise en place d'un pipeline d'intégration continue (CI) sur GitLab pour une application Node.js simple
Objectifs du TP¶
- Comprendre la structure d'un fichier
.gitlab-ci.yml - Initialiser un projet Node.js et son serveur Express
- Configurer des étapes d'installation, de lint et de build automatisées
- Distinguer le cache et les artifacts, puis optimiser le pipeline avec le cache
- Diagnostiquer un job en échec à partir de ses logs
Étape 1 : Le "Hello World" de la CI¶
Avant de manipuler du code applicatif, nous allons valider que votre environnement GitLab fonctionne correctement
- Créez un fichier nommé
.gitlab-ci.ymlà la racine de votre dépôt - Définissez une étape (stage) nommée
test - Créez un job nommé
hello_jobqui appartient à cette étape et dont le script affiche simplement "Hello World" dans les logs - Commitez ce fichier et vérifiez dans l'interface GitLab (section Build > Pipelines) que votre job s'exécute avec succès
Étape 2 : Préparation de l'application Node.js¶
Nous allons maintenant créer une application web très simple avec le framework Express
- Initialisez un nouveau projet Node.js avec la commande
npm init - Installez la dépendance
express - Créez un fichier
index.jsqui démarre un serveur sur le port 3000 et répond "Hello World" sur la route racine/ - Testez votre application localement avec
node index.jspour vous assurer qu'elle fonctionne - Pensez à ajouter un fichier
.gitignorepour ne pas envoyer le dossiernode_modulessur votre dépôt Git
Étape 3 : Automatisation de l'installation et du build¶
Maintenant que l'application est prête, nous voulons que GitLab s'occupe de préparer l'environnement à chaque changement de code
- Modifiez votre fichier
.gitlab-ci.ymlpour utiliser l'image Dockernode:24-alpine - Définissez deux étapes :
installetbuild - Créez un job
install_dependenciesdans le stageinstallqui utilise la commandenpm ci(plus rapide et stable quenpm installdans un contexte CI), et transmettez le dossiernode_modules/au job suivant avecartifacts:paths - Créez un job
build_appdans le stagebuildqui exécute la commande de build de votre projet- Indice : Vous devrez probablement ajouter un script
"build": "echo 'Building...'"dans votrepackage.jsonpour nous faciliter cette étape
- Indice : Vous devrez probablement ajouter un script
Étape 4 : Qualité du code avec un linter¶
Un linter vérifie le code sans l'exécuter : variables inutilisées, erreurs de syntaxe, mauvaises pratiques. Placé juste après l'installation, il donne un retour en quelques secondes
- Installez et initialisez ESLint en local avec
npm init @eslint/config@latest(répondez aux questions pour un projet JavaScript Node.js) : la commande génère un fichiereslint.config.mjset ajoute ESLint à vosdevDependencies - Ajoutez un script
"lint": "eslint ."dans votrepackage.jsonet vérifiez qu'il passe en local avecnpm run lint - Ajoutez un stage
lintentreinstalletbuilddans votre.gitlab-ci.yml - Créez un job
lint_codedans ce stage qui exécutenpm run lint: il réutilise le dossiernode_modules/transmis par l'artifact du jobinstall_dependencies - Déclarez volontairement une variable inutilisée dans
index.js, poussez, et vérifiez que le joblint_codeéchoue et que le pipeline s'arrête avant le build - Corrigez le code et vérifiez que le pipeline repasse au vert
Étape 5 : Optimisation avec le cache¶
Vous remarquerez que chaque job repart d'un environnement vide. Pour éviter de télécharger les dépendances à chaque fois, nous allons utiliser le cache
- Ajoutez une section
cacheglobale dans votre configuration - Configurez-la pour conserver le dossier de cache npm
.npm/, et lancez l'installation avecnpm ci --cache .npm --prefer-offline(npm cisupprimenode_modulesà chaque exécution : le mettre en cache n'accélérerait rien) - Observez la différence de temps d'exécution sur vos prochains pipelines
Cache ou artifact ?
Le cache accélère les pipelines suivants, mais sans garantie : il peut être absent ou vidé, et le job doit fonctionner sans lui. L'artifact transmet de façon garantie un résultat aux jobs suivants du même pipeline : c'est le bon outil pour node_modules/ entre install et lint
Étape 6 : Débogage d'un pipeline en échec¶
Savoir lire un log de job est une compétence quotidienne : l'objectif est de remonter du symptôme à la cause, sans deviner
Pour chacun des cas suivants, provoquez l'erreur, retrouvez dans les logs la ligne qui donne la cause, puis corrigez et vérifiez que le pipeline repasse au vert :
- Image introuvable : remplacez l'image par
node:24-alpinee(faute de frappe). Le job échoue avant même d'exécuter votre script : repérez le message du runner qui n'arrive pas à récupérer l'image - YAML invalide : cassez l'indentation d'une clé de votre
.gitlab-ci.yml. Le pipeline ne démarre pas du tout : ouvrez Build > Pipeline editor pour retrouver la ligne en cause - Artifact oublié : supprimez la section
artifactsdu jobinstall_dependencies. Le joblint_codeéchoue, car la commandeeslintest introuvable : expliquez pourquoi le cache ne suffit pas à transmettrenode_modules/ - Erreur de lint : réintroduisez une variable inutilisée et retrouvez dans le log le nom de la règle ESLint, le fichier et la ligne en cause
Pour chaque cas, notez dans votre README le symptôme, la cause et la correction : c'est exactement la démarche attendue face à un incident en production
Étape 7 : Bonus - Vérification des dépendances¶
Il est important de savoir si vos bibliothèques sont à jour pour éviter des failles de sécurité ou des bugs
- Ajoutez un job nommé
check_updatesdans un stagetest(pensez à déclarer ce stage dans la listestages) - Utilisez la commande
npm outdatedpour l'exécuter - Utilisez l'option
allow_failure: truepour que votre pipeline ne soit pas bloqué si une mise à jour est disponible, car c'est une information informative pour ce TP