Votre changelog reprend les fonctionnalités que vous avez réalisé entre deux versions, ça tombe bien, votre historique git contient ces informations 🙂 On va voir comment les extraire de git pour générer automatiquement un changelog exhaustif et fiable.
Sommaire
Pour faciliter la maintenance de votre projet, il est d’usage d’avoir des commits parlants afin que tous les développeurs puissent connaître les raisons d’un changement.
On va simplement appliquer une norme aux messages de nos commits:
etc..
Des outils permettent d’automatiser cette tâche comme commitzen:
Exemple:
Quand vous préparez une release, vous allez normalement créer un tag pour votre version.
Des utilitaires vont simplement lire les messages des commits qui ont eu lieu entre vos tags et vont déterminer lesquels écrire dans le changelog en fonction de leur préfixe, c’est tout !
Si j’écrivais dans mon changelog à la main jusqu’à la version v0.1.0 et qu’à partir de la prochaine version v0.2.0 je veux qu’il soit généré automatiquement:
Je peux exécuter la commande:
cz changelog --incremental --unreleased-version="v0.2" 
Le changelog a été édité pour la version v0.2.0 uniquement, c’est donc très facile à mettre en place car ça n’affecte pas les informations de vos précédentes versions !
Choisissez une convention de nommage et un outil adapté, c’est tout !
J’ai mis dans les exemples précédents un usage avec Commitzen car c’est ce que j’utilise au quotidien actuellement (et j’en suis satisfait) mais d’autres options existent.
Par exemple, sur des projets JS, vous poulez écrire vos message de commit à la main en suivant https://www.conventionalcommits.org/en/v1.0.0/ et utiliser https://www.npmjs.com/package/conventional-changelog-cli ça marche très bien aussi.
Written By
On va voir comment avoir en quelques minutes des assertions qui vont vérifier les endpoints de notre API avec des scénarios de ce genre: Feature: Create a new account As a visitor, I can create an account to access the game Scenario: A visitor creates an account When I fill the login form with | email | password | | [email protected] | Jh0...
Depuis .NET 9, le le support d’OpenAPI est directement inclus dans .NET et ne passe plus par les librairies Swagger par défaut (plus d’info sur ce choix ici si jamais ça vous intéresse). De façons simplifiée, la librairie Swashbuckle.AspNetCore.Sw...
Description du problème Par défaut, il n’est pas autorisé de faire des requêtes entre une application qui est dans un domaine A vers une autre qui serait dans un domaine B (pour des raisons de sécurité, il y a plus de détails dans les sources). S...
On va créer pas-à-pas un raccourci qui nous permettra de générer un IBAN et de l’insérer à l’endroit où se trouve notre curseur. Si vous n’avez pas fait le setup pour développer un plugin Jetbrains, je vous invite à lire notre article sur le sujet. ...