API NestJS minimaliste — support du TP 3 cours-03 (Release-Based Workflow).
| Branche | Rôle |
|---|---|
main |
Ligne d'intégration de la prochaine version |
release/v1.0 |
Version 1.0 déjà livrée et maintenue |
release/v1.1 |
Version 1.1 créée pendant le TP depuis main, au moment du gel |
feature/... |
Développement d'une fonctionnalité → fusionne dans main |
hotfix/... |
Correctif urgent → fusionne dans la branche release/... concernée, puis est reporté sur les autres lignes concernées |
Détail des règles et cycles de vie → BRANCHES.md
Par défaut, les Pull Requests sont ouvertes dans ton fork : par exemple hotfix/fix-title-validation est proposée vers release/v1.0 de ton dépôt forké.
Si l'enseignant le demande explicitement, la Pull Request peut viser le dépôt central GVI2026/tp-release-based-workflow. Sans droit d'écriture ou sans accès GitHub disponible, le scénario peut être simulé localement avec les merges et cherry-pick indiqués dans ce README, en gardant la même logique de revue et de validation.
Prérequis : VS Code + Docker Desktop + extension Dev Containers
-
Forker le dépôt sur GitHub, puis le cloner :
git clone <url-de-ton-fork> cd tp-release-based-workflow
-
Ouvrir dans VS Code et accepter "Reopen in Container" — ou via la palette de commandes :
Dev Containers: Reopen in Container -
Attendre l'initialisation (première fois ~2 min). Les dépendances npm et les migrations Prisma s'exécutent automatiquement.
-
Lancer l'application :
npm run start:dev
-
Swagger disponible sur http://localhost:3000/api
Prérequis : Node.js 24, PostgreSQL 18
-
Copier et renseigner les variables d'environnement :
cp .env.example .env # Éditer .env : renseigner DATABASE_URL -
Installer les dépendances :
npm install
-
Appliquer les migrations :
npx prisma migrate dev --name init
-
Lancer l'application :
npm run start:dev
npm test| Méthode | Route | Description |
|---|---|---|
POST |
/tasks |
Créer une tâche |
GET |
/tasks |
Lister toutes les tâches |
GET |
/tasks/:id |
Récupérer une tâche |
PATCH |
/tasks/:id |
Mettre à jour une tâche |
DELETE |
/tasks/:id |
Supprimer une tâche |
GET |
/tasks/stats |
À implémenter sur la prochaine version — { total, done, pending } |
- Forker le dépôt sur GitHub, puis le cloner.
- Vérifier que les branches initiales existent :
Tu dois voir
git branch -a
mainetorigin/release/v1.0. - Se placer sur
main:git checkout main
- Observer l'état initial de
release/v1.0:La branche contient déjà le commitgit checkout release/v1.0 git log --oneline --decorate -5
chore(release): bump project to version 1.0.0, sur lequel sont posés le tag et la releasev1.0.0. - Revenir sur
main:git checkout main
- Créer la branche de fonctionnalité depuis
main:git checkout -b feature/add-task-stats
- Implémenter
GET /tasks/statsdansTasksServiceetTasksController. - Décommenter le bloc
TODOdanstasks.service.spec.tset l'adapter. - Vérifier que tous les tests passent :
npm test - Committer proprement :
git add .
git commit -m "feat: add task stats endpoint"- Pousser la branche et ouvrir une Pull Request vers
main.
Dans un Release-Based Workflow, une version peut être figée dans une branche dédiée pendant que main continue à préparer la suite. La branche de release est un sanctuaire : on n'y développe pas une nouvelle fonctionnalité, on y stabilise ce qui a déjà été intégré.
- Une fois la fonctionnalité intégrée dans
main, créerrelease/v1.1depuismain:git checkout main git pull git checkout -b release/v1.1
- Vérifier que
release/v1.1contient la fonctionnalité/tasks/stats. - Mettre à jour la version du projet dans
package.jsonetpackage-lock.json:npm version 1.1.0 --no-git-tag-version
- Committer la stabilisation :
git add package.json package-lock.json git commit -m "chore(release): bump project to version 1.1.0" - Pousser la branche
release/v1.1, puis poser le tag ou créer la release GitHubv1.1.0après validation.
La validation du champ title est volontairement incomplète : un POST /tasks avec { "title": "" } accepte une chaîne vide.
- Basculer sur la branche de release v1.0 :
git checkout release/v1.0
- Créer une branche de correctif depuis cette release :
git checkout -b hotfix/fix-title-validation
- Corriger le problème dans
CreateTaskDto. - Ajouter ou adapter un test qui vérifie que le titre vide est rejeté.
- Vérifier que tous les tests passent :
npm test - Committer proprement :
git add . git commit -m "fix: reject empty task title"
- Pousser la branche et ouvrir une Pull Request vers
release/v1.0.
Un correctif critique ne doit pas rester isolé sur release/v1.0 si le même bug existe aussi dans main ou dans release/v1.1.
- Noter le SHA du commit de hotfix, puis le reporter sur
mainsi le bug existe dans la ligne d'intégration :git checkout main git cherry-pick <sha-du-commit-hotfix>
- Vérifier les tests, puis pousser
main. - Reporter aussi le correctif sur
release/v1.1si la branche a déjà été créée et si le bug y existe :git checkout release/v1.1 git cherry-pick <sha-du-commit-hotfix>
- Vérifier que
release/v1.0,mainetrelease/v1.1contiennent toutes le correctif attendu.
Après avoir terminé le scénario principal, traite un second correctif mineur sur release/v1.0, puis reporte-le également sur main et release/v1.1.
L'objectif du bonus n'est pas d'ajouter une nouvelle notion, mais de renforcer l'idée centrale du Release-Based Workflow : plusieurs versions livrables impliquent parfois plusieurs corrections coordonnées.
Tu peux par exemple :
- corriger un second bug simple sur
release/v1.0, - le commit en
fix: ..., - puis le reporter proprement avec
cherry-pick.
Avant la séance, s'assurer que :
- La branche
release/v1.0existe et est poussée. mainreprésente la ligne d'intégration de la prochaine version.release/v1.0représente une version déjà livrée et encore maintenue.release/v1.0contient le commitchore(release): bump project to version 1.0.0, taguév1.0.0.- Il n'y a pas de branche
release/v1.1au départ : elle est créée pendant le TP depuismain. mainetrelease/v1.0sont protégées : Pull Request obligatoire, CI verte avant merge.npm testest vert sur un dépôt fraîchement cloné.- Les versions sont modifiées dans
package.jsonetpackage-lock.json, pas dans un fichierVERSION. - Le tag ou la release GitHub
v1.0.0matérialise l'état initial ;v1.1.0sera créé pendant le TP après stabilisation.
Pour que le TP soit parlant, préparer un historique simple montrant que release/v1.0, main et release/v1.1 sont des lignes différentes, mais que certains correctifs doivent rester alignés entre elles.