GitLab de A à Z : Git, runner et pipeline

On part de zéro et on arrive à un vrai cycle de travail : tu modifies du code sur ton poste, tu le pousses sur GitLab, ton propre runner exécute le pipeline, et tu passes par une branche et une merge request avant de déployer.

Installer et configurer Git

sudo apt update && sudo apt install -y git
git --version

Git signe chaque commit avec un nom et un e-mail. Mets les mêmes que sur ton compte GitLab :

git config --global user.name "Jocelin Rey"
git config --global user.email "[email protected]"
git config --global init.defaultBranch main
git config --global --list

Ajouter ta clé SSH à GitLab

SSH évite de taper un mot de passe à chaque push. Si tu n'as pas encore de clé :

ssh-keygen -t ed25519 -C "jocelin@poste"
cat ~/.ssh/id_ed25519.pub

Copie toute la ligne affichée (elle commence par ssh-ed25519). Dans GitLab : Ton avatar (en haut à droite) › Edit profile › Access › SSH keys › Add new key.

Teste la connexion :

ssh -T [email protected]

Welcome to GitLab, @jrey!

Créer le projet sur GitLab

+ (en haut de la barre latérale) › New project/repository › Create blank project.

GitLab ouvre la page du projet avec un premier commit (le README) :

Cloner le projet sur ton poste

Bouton Code (ou Clone selon la version), puis copie l'adresse Clone with SSH :

cd ~
git clone [email protected]:jrey/mon-site.git
cd mon-site
ls

Tu as maintenant une copie complète du dépôt, avec son historique. origin est le nom donné automatiquement au dépôt GitLab d'où tu as cloné.

Faire ton premier commit

Crée le fichier index.html à la racine du projet :

<!doctype html>
<html lang="fr">
<head>
  <meta charset="utf-8">
  <title>Mon site</title>
</head>
<body>
  <h1>Bonjour depuis GitLab CI</h1>
</body>
</html>

Un fichier passe par trois zones avant d'arriver sur GitLab :

git status

Untracked files:
  (use "git add <file>..." to include in what will be committed)
	index.html

git add index.html
git commit -m "Ajoute la page d'accueil"
git push

Installer le runner sur la VM Debian

Le runner est le programme qui exécute les jobs. On utilise l'exécuteur Docker : chaque job tourne dans un conteneur neuf, jeté à la fin. La VM reste propre.

Docker

curl -fsSL https://get.docker.com | sudo sh
sudo docker run --rm hello-world

GitLab Runner

curl -L "https://packages.gitlab.com/install/repositories/runner/gitlab-runner/script.deb.sh" | sudo bash
sudo apt install -y gitlab-runner
gitlab-runner --version

Créer le runner dans GitLab

Dans le projet : Settings › CI/CD › Runners (Expand) › Create project runner.

Choisis Linux. GitLab affiche la commande d'enregistrement avec le token du runner :

Enregistrer le runner

Sur la VM, colle ton token à la place de glrt-... :

sudo gitlab-runner register --non-interactive \
  --url "https://gitlab.com" \
  --token "glrt-t1_xxxxxxxxxxxxxxxxxxxx" \
  --executor "docker" \
  --docker-image "alpine:3.22" \
  --name "runner-debian-01"

Runner registered successfully. Feel free to start it, but if it's running already the config should be automatically reloaded!

Le service tourne déjà (installé par le paquet). Vérifie :

sudo gitlab-runner list
sudo gitlab-runner verify
systemctl status gitlab-runner --no-pager

Dans GitLab, Settings › CI/CD › Runners : ton runner apparaît avec une pastille verte Online. Sa fiche indique le dernier contact et la version :

Écrire le pipeline

Crée .gitlab-ci.yml à la racine du projet (le point au début du nom est obligatoire) :

stages:
  - build
  - test
  - deploy

default:
  image: alpine:3.22
  tags:
    - debian

build-job:
  stage: build
  script:
    - echo "Construction du site pour le commit $CI_COMMIT_SHORT_SHA"
    - mkdir -p public
    - cp index.html public/
    - echo "$CI_COMMIT_SHORT_SHA" > public/version.txt
  artifacts:
    paths:
      - public/
    expire_in: 1 week

test-html:
  stage: test
  script:
    - test -f public/index.html
    - grep -q "<title>" public/index.html

test-version:
  stage: test
  script:
    - test -s public/version.txt
    - cat public/version.txt

deploy-prod:
  stage: deploy
  script:
    - echo "Déploiement de la version $(cat public/version.txt) sur $CI_ENVIRONMENT_NAME"
    - echo "Le jeton vaut $DEPLOY_TOKEN"
    - tar -czf site.tar.gz -C public .
  artifacts:
    paths:
      - site.tar.gz
  environment: production
  rules:
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
      when: manual

Pousser et suivre le pipeline

git add .gitlab-ci.yml
git commit -m "Ajoute le pipeline CI"
git push

Dès le push, GitLab crée un pipeline. Ouvre Build › Pipelines :

Clique sur le pipeline pour voir le graphe des étapes :

Clique sur un job pour lire son journal :

Ajouter une variable secrète

Un mot de passe ou un token ne doit jamais être écrit dans le dépôt. On le range dans GitLab : Settings › CI/CD › Variables (Expand) › Add variable.

Le job deploy-prod l'utilise déjà avec $DEPLOY_TOKEN. Masquée, elle n'apparaîtra jamais en clair dans les journaux :

$ echo "Le jeton vaut $DEPLOY_TOKEN"
Le jeton vaut [MASKED]

Lancer le déploiement manuel

Dans Build › Pipelines, le bouton ▶ de la ligne du pipeline liste les jobs manuels. Choisis deploy-prod :

$ echo "Déploiement de la version $(cat public/version.txt) sur $CI_ENVIRONMENT_NAME"
Déploiement de la version 892bc2aa sur production
$ echo "Le jeton vaut $DEPLOY_TOKEN"
Le jeton vaut [MASKED]
$ tar -czf site.tar.gz -C public .
Job succeeded

Operate › Environments affiche maintenant production avec la version déployée et le commit correspondant.

Travailler sur une branche

On ne modifie pas main directement : on crée une branche, on y travaille, et on la fusionne une fois validée.

git switch main
git pull
git switch -c feature/nouveau-titre

Dans index.html, remplace le titre Bonjour depuis GitLab CI par Bienvenue sur mon site. Puis vérifie ce que tu as changé :

git status --short
git diff

-  <h1>Bonjour depuis GitLab CI</h1>
+  <h1>Bienvenue sur mon site</h1>

git add index.html
git commit -m "Change le titre de la page"
git push -u origin feature/nouveau-titre

-u relie ta branche locale à celle de GitLab : les prochains git push et git pull sur cette branche n'auront plus besoin d'arguments. GitLab répond avec un lien direct pour créer la merge request :

remote: To create a merge request for feature/nouveau-titre, visit:
remote:   https://gitlab.com/jrey/mon-site/-/merge_requests/new?merge_request%5Bsource_branch%5D=feature%2Fnouveau-titre

Ouvrir et fusionner une merge request

Ouvre le lien affiché par le push (ou Create merge request dans le bandeau du projet). Donne un titre, laisse Delete source branch coché :

Sur la page de la merge request : l'onglet Changes montre le diff, et le pipeline de la branche s'affiche en haut. Quand il est vert, clique sur Merge.

Récupérer le résultat sur ton poste

git switch main
git pull
git branch -d feature/nouveau-titre
git fetch --prune
git log --oneline --graph -5

*   35a477d Merge branch 'feature/nouveau-titre' into 'main'
|\
| * 009afc5 Change le titre de la page
|/
* 892bc2a Ajoute le pipeline CI

Le pipeline de main propose à nouveau deploy-prod : lance-le pour mettre en production la nouvelle version. La boucle est complète.

Corriger une erreur

Aide-mémoire Git

Si ça bloque