Générer des journaux des modifications et des notes de version
Apprenez à produire des journaux des modifications clairs et des notes de version automatisées à partir de votre historique Git et de vos validations conventionnelles.
Générer des journaux des modifications et des notes de version est une leçon Git & GitHub Professional Workflow gratuite sur CoddyKit. Ceci est la leçon 4 sur 4. Tu peux lire la leçon complète ci-dessous gratuitement — puis la pratiquer en direct dans le navigateur avec un éditeur de code intégré et un tuteur IA 24/7. Elle fait partie du parcours d'apprentissage Git & GitHub Professional Workflow, et ta progression se synchronise sur le web et l'application CoddyKit. Le cours Git & GitHub Professional Workflow comprend 4 leçons au total.
Qu'est-ce qu'un journal des modifications ?
Un journal des modifications est une liste sélectionnée et lisible par les humains des changements importants apportés à chaque version. Il se trouve dans un fichier comme CHANGELOG.md, à la racine du dépôt.
Pourquoi les journaux des modifications sont importants
Les utilisateurs et les membres de l'équipe consultent les journaux des modifications pour comprendre :
- Les nouvelles fonctionnalités
- Les corrections de bogues
- Les changements incompatibles
Ils rendent les mises à niveau plus sûres et plus rapides.
Format Keep a Changelog
Une convention courante consiste à regrouper les entrées sous les rubriques Ajouté, Modifié, Corrigé et Supprimé.
## [1.2.0] - 2024-05-01
### Added
- Search filters
### Fixed
- Login redirect bugValidations conventionnelles
Les validations conventionnelles utilisent des préfixes comme feat:, fix: et BREAKING CHANGE:, afin que les outils puissent générer automatiquement des journaux des modifications.
feat: add CSV export
fix: handle empty cart
feat!: drop Node 14 supportRépertorier les validations depuis une étiquette
Vous pouvez prévisualiser les changements effectués depuis la dernière version à l'aide de git log et d'une plage d'étiquettes.
git log v1.1.0..HEAD --onelineJournal formaté pour les notes
Formatez le journal en lignes à puces adaptées à un collage dans les notes de version.
git log v1.1.0..HEAD --pretty=format:'- %s'Outils automatisés pour les journaux des modifications
Des outils comme standard-version ou conventional-changelog lisent les validations conventionnelles et génèrent le journal des modifications ainsi qu'une nouvelle version.
npx standard-versionNotes générées automatiquement par GitHub
GitHub peut générer automatiquement les notes de version à partir des demandes de fusion lorsque vous créez une version.
gh release create v1.2.0 --generate-notesCatégoriser avec des étiquettes
Un fichier .github/release.yml associe les étiquettes des PR aux sections du journal des modifications, afin de regrouper automatiquement les corrections de bogues et les fonctionnalités.
changelog:
categories:
- title: Features
labels: [feature]Réviser avant la publication
Lisez toujours les notes générées avant de les publier. L'automatisation en prépare une première version, mais une personne révise la formulation et met en évidence les changements incompatibles.
Associer les entrées aux versions
Associez chaque entrée du journal des modifications à son étiquette Git et à sa page de version, afin que les lecteurs puissent accéder directement à la comparaison exacte.
[1.2.0]: https://github.com/you/repo/compare/v1.1.0...v1.2.0Vérification rapide
Vérifiez votre compréhension des journaux des modifications et des notes de version.
Récapitulatif
Vous avez appris à générer des journaux des modifications :
- Utilisez le format Keep a Changelog
- Les validations conventionnelles alimentent l'automatisation
git log v1..HEADaffiche un aperçu des changementsgh release create --generate-notesprépare des notes à partir des PR
Questions Fréquemment Posées
La leçon « Générer des journaux des modifications et des notes de version » est-elle gratuite ?
Oui — le texte complet de « Générer des journaux des modifications et des notes de version » est gratuit à lire ici sur le web. Pour la pratiquer de manière interactive (un éditeur de code intégré et un tuteur IA 24/7) et déverrouiller le reste du cours Git & GitHub Professional Workflow, passe à CoddyKit PRO. Le cours Git & GitHub Professional Workflow comprend 4 leçons au total.
Qu'est-ce que j'apprendrai dans « Générer des journaux des modifications et des notes de version » ?
Apprenez à produire des journaux des modifications clairs et des notes de version automatisées à partir de votre historique Git et de vos validations conventionnelles. Tu pratiques Git & GitHub Professional Workflow avec du code pratique que tu exécutes directement dans le navigateur, et un tuteur IA 24/7 répond à tes questions au fur et à mesure que tu avances dans la leçon.
Dois-je avoir de l'expérience pour commencer Git & GitHub Professional Workflow ?
Aucune expérience préalable n'est requise. Git & GitHub Professional Workflow sur CoddyKit est structuré pour les débutants jusqu'aux apprenants avancés, donc tu peux commencer ici ou depuis le début et avancer à ton rythme. Ceci est la leçon 4 sur 4.
Combien de temps prend la leçon « Générer des journaux des modifications et des notes de version » ?
La plupart des leçons CoddyKit prennent environ 5–10 minutes. Chacune est courte et interactive, tu progresses régulièrement et tu repiques exactement où tu t'es arrêté sur le web et l'app.
Peux-tu écrire et exécuter du code dans cette leçon Git & GitHub Professional Workflow ?
Oui. Chaque leçon Git & GitHub Professional Workflow inclut un éditeur de code intégré, tu écris et exécutes du vrai code directement dans ton navigateur et tu reçois des retours IA instantanés — aucune configuration locale requise.
Toutes les leçons de ce cours
- Gestion sémantique des versions avec des tags
- Créer et gérer des versions
- Branches de version et correctifs urgents
- Générer des journaux des modifications et des notes de version