Skip to content

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

tp-release-based-workflow

API NestJS minimaliste — support du TP 3 cours-03 (Release-Based Workflow).


Branches du projet

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


Contexte des Pull Requests en TP

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.


Démarrage recommandé — DevContainer (Windows / Linux / macOS)

Prérequis : VS Code + Docker Desktop + extension Dev Containers

  1. Forker le dépôt sur GitHub, puis le cloner :

    git clone <url-de-ton-fork>
    cd tp-release-based-workflow
  2. Ouvrir dans VS Code et accepter "Reopen in Container" — ou via la palette de commandes : Dev Containers: Reopen in Container

  3. Attendre l'initialisation (première fois ~2 min). Les dépendances npm et les migrations Prisma s'exécutent automatiquement.

  4. Lancer l'application :

    npm run start:dev
  5. Swagger disponible sur http://localhost:3000/api


Démarrage manuel (sans DevContainer)

Prérequis : Node.js 24, PostgreSQL 18

  1. Copier et renseigner les variables d'environnement :

    cp .env.example .env
    # Éditer .env : renseigner DATABASE_URL
  2. Installer les dépendances :

    npm install
  3. Appliquer les migrations :

    npx prisma migrate dev --name init
  4. Lancer l'application :

    npm run start:dev

Lancer les tests

npm test

Routes disponibles

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 }

Scénario Release-Based Workflow

Étape 0 — Mise en place

  1. Forker le dépôt sur GitHub, puis le cloner.
  2. Vérifier que les branches initiales existent :
    git branch -a
    Tu dois voir main et origin/release/v1.0.
  3. Se placer sur main :
    git checkout main
  4. Observer l'état initial de release/v1.0 :
    git checkout release/v1.0
    git log --oneline --decorate -5
    La branche contient déjà le commit chore(release): bump project to version 1.0.0, sur lequel sont posés le tag et la release v1.0.0.
  5. Revenir sur main :
    git checkout main

Étape 1 — Ajouter une fonctionnalité pour la prochaine version

  1. Créer la branche de fonctionnalité depuis main :
    git checkout -b feature/add-task-stats
  2. Implémenter GET /tasks/stats dans TasksService et TasksController.
  3. Décommenter le bloc TODO dans tasks.service.spec.ts et l'adapter.
  4. Vérifier que tous les tests passent :
    npm test
  5. Committer proprement :
git add .
git commit -m "feat: add task stats endpoint"
  1. Pousser la branche et ouvrir une Pull Request vers main.

Étape 2 — Stabiliser la version 1.1

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é.

  1. Une fois la fonctionnalité intégrée dans main, créer release/v1.1 depuis main :
    git checkout main
    git pull
    git checkout -b release/v1.1
  2. Vérifier que release/v1.1 contient la fonctionnalité /tasks/stats.
  3. Mettre à jour la version du projet dans package.json et package-lock.json :
    npm version 1.1.0 --no-git-tag-version
  4. Committer la stabilisation :
    git add package.json package-lock.json
    git commit -m "chore(release): bump project to version 1.1.0"
  5. Pousser la branche release/v1.1, puis poser le tag ou créer la release GitHub v1.1.0 après validation.

Étape 3 — Corriger un bug urgent sur la version 1.0

La validation du champ title est volontairement incomplète : un POST /tasks avec { "title": "" } accepte une chaîne vide.

  1. Basculer sur la branche de release v1.0 :
    git checkout release/v1.0
  2. Créer une branche de correctif depuis cette release :
    git checkout -b hotfix/fix-title-validation
  3. Corriger le problème dans CreateTaskDto.
  4. Ajouter ou adapter un test qui vérifie que le titre vide est rejeté.
  5. Vérifier que tous les tests passent :
    npm test
  6. Committer proprement :
    git add .
    git commit -m "fix: reject empty task title"
  7. Pousser la branche et ouvrir une Pull Request vers release/v1.0.

Étape 4 — Reporter le correctif sur les versions parallèles

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.

  1. Noter le SHA du commit de hotfix, puis le reporter sur main si le bug existe dans la ligne d'intégration :
    git checkout main
    git cherry-pick <sha-du-commit-hotfix>
  2. Vérifier les tests, puis pousser main.
  3. Reporter aussi le correctif sur release/v1.1 si 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>
  4. Vérifier que release/v1.0, main et release/v1.1 contiennent toutes le correctif attendu.

Pour les plus rapides — Exercice optionnel validé

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.

Note de setup — enseignant

Avant la séance, s'assurer que :

  • La branche release/v1.0 existe et est poussée.
  • main représente la ligne d'intégration de la prochaine version.
  • release/v1.0 représente une version déjà livrée et encore maintenue.
  • release/v1.0 contient le commit chore(release): bump project to version 1.0.0, tagué v1.0.0.
  • Il n'y a pas de branche release/v1.1 au départ : elle est créée pendant le TP depuis main.
  • main et release/v1.0 sont protégées : Pull Request obligatoire, CI verte avant merge.
  • npm test est vert sur un dépôt fraîchement cloné.
  • Les versions sont modifiées dans package.json et package-lock.json, pas dans un fichier VERSION.
  • Le tag ou la release GitHub v1.0.0 matérialise l'état initial ; v1.1.0 sera 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.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages