- la commmande music play pour écouter de la musique !
- et quelques autres ajouts mineurs à découvrir avec la commande
help
Notre projet est un terminal de commande construit avec la bibliothèque React. il permet aux utilisateurs d'interagir à travers des commandes.
- Louis Maupas & Lucas Michon
-
git clone https://github.com/LouisMaupas/devOpsIsitech.git
-
cd devOpsIsitech/devOpsIsitech
-
pnpm install
-
pnpm run dev
Tapez
help
pour avoir la liste des commandes
- Gestionnaire de paquets : pnpm
- Front : React
- Environnement de développement et de construction : Vite
- Test : Jest
- Linter : EsLint
- Versionning et travail collaboratif : Git / Github
- Plateforme de CI/CD : Github Actions
- Hebergement : Vercel
- Messages de commits : Conventional Commits
- Utilisation de tag pour le versionning selon le standard de Gestion sémantique de version 2.0.0
- main : branche principal, contient le code qui va en production.
- Dev : branche tampon entre main et les branches de feat/fix
- feat# / fix# / ... : branche temporaire crée à partir de dev, dédiée à la résolution d'un bug ou création d'une nouvelle feature. Elle est fusionné à main puis supprimée une fois le ticket clos ou la feature ajoutée.
Voir ci-dessous pour le schéma récapitulatif du Workflow
- Un premier développeur va ouvrir un ticket (issue) sur Github.
- Le développeur à qui est assigné le ticket suit le Workflow
-
Création d'une nouvelle branche locale nommée feat#12 à partir de la branche origin/Dev
git switch -c feat#12
-
En local, le développeur code la fonctionnalité et commit (avec squash si nécessaire).
-
Une fois la feature terminée, le développeur push directement sur Dev et la pipeline s'active.
git checkout Dev
ougit switch Dev
pour switch sur la branche Dev.git pull
⚠️ 🔺 pour vérifier qu'on est à jour 🔺⚠️ git merge currentFeatureOrFix
pour fusionner la branche currentFeatureOrFix avec la branche dev.git push
on push sur la branche distante (origin/Dev).git tag -a vX.X -m "Description"
si nécessaire ajouté un tag...git push --tags
...et l'envoyer.
-
Sur Github, le développeur fait une demande de merge de la branche origin/Dev vers origin/main : Create Pull Request
-
Un second développeur doit commenter, approuver ou demander des changement sur la demande de merge.
-
La pipeline s'execute
actions/checkout@v2
: est l'étape pour récupérer les sources de l'application depuis le référentiel Git.Install Vercel CLI
: installe la dernière version du CLI Vercel.Clear Cache
: vide le cacheInstall Dependencies
: installe les dépendances pour l'application.Lint
: execute l'outil de linting pour vérifier la qualité du code.Tests
: execute les tests unitaires.
Notre pipeline intègre un job de tests, mais nous pouvons exécuter les tests manuellement avec la commande pnpm test
.
Nous pouvons voir la couverture de test grâce à la commande
pnpm test -- --coverage