changelog

À propos changelog

La compétence « changelog » automatise le processus de génération des entrées changelog à partir des commits Git effectués depuis la dernière version. Elle est conçue pour aider les équipes de développement à maintenir un historique cohérent et axé sur l’utilisateur des modifications apportées à leurs projets. En analysant les messages de commit et en distinguant les modifications visibles par les utilisateurs de celles internes, cette compétence garantit que le fichier ` CHANGELOG.md` reflète des mises à jour pertinentes pour les utilisateurs finaux. Cela réduit le travail manuel, évite que des modifications ne soient négligées et garantit que la documentation de la version reste précise et à jour.

Cette compétence fournit un workflow structuré pour extraire les informations de commit, catégoriser les modifications et formater les entrées selon un style standardisé. Parmi ses principales fonctionnalités, on peut citer l’identification des modifications destinées aux utilisateurs, telles que les nouvelles fonctionnalités, les corrections de bogues, les améliorations de performances, les dépréciations et les mises à jour de sécurité, tout en excluant les modifications purement internes comme la refactorisation, les tests ou les modifications CI/CD. Elle extrait automatiquement les références aux tickets à partir des messages de commit et organise les entrées en catégories prédéfinies (Ajouté, Modifié, Corrigé, Supprimé, Obsolète, Sécurité). De plus, il détermine la section appropriée de l’ changelog en fonction de la branche actuelle, prenant en charge à la fois les versions publiées et une section « Non publiée ». Cette compétence utilise des commandes Bash et l’outil Edit pour lire et mettre à jour l’ changelog en toute transparence.

Cette skill est idéale pour les développeurs, les responsables de versions et les équipes chargées de la maintenance de projets logiciels open source ou internes qui souhaitent rationaliser la gestion de l’ changelog. Elle est particulièrement utile pour les projets comportant des commits fréquents ou de multiples contributeurs, car elle garantit que toutes les modifications pertinentes pour les utilisateurs sont documentées de manière cohérente. Les utilisateurs bénéficient d’un gain de temps, d’une réduction des erreurs et d’une « changelog » professionnelle et structurée qui communique clairement les mises à jour aux utilisateurs finaux, aux parties prenantes et aux contributeurs.

FAQ

Comment utiliser la compétence « changelog » ?

Commencez par exécuter la skill sur le dépôt de votre projet. Elle détectera automatiquement les commits effectués depuis la dernière version, classera les modifications visibles par les utilisateurs, extraira les références aux tickets et mettra à jour le fichier ` CHANGELOG.md` dans la section appropriée (version non publiée ou version publiée).

Quels types de modifications sont inclus dans le fichier « changelog » ?

La skill inclut les modifications visibles par les utilisateurs, telles que les nouvelles fonctionnalités, les corrections de bogues, les améliorations de performances, les changements de compatibilité, les dépréciations et les correctifs de sécurité. Les modifications internes, telles que la refactorisation, les tests, le CI/CD ou les mises à jour du style de code, sont exclues, sauf si elles affectent le comportement visible par les utilisateurs.

Peut-elle traiter des dépôts ne comportant pas de balises de version antérieures ?

Oui, s’il n’existe aucune balise de version antérieure, la skill analyse les commits les plus récents (jusqu’à 50) pour générer des entrées « changelog » et les place dans la section « Non publié ».

Fusionne-t-il automatiquement les nouvelles entrées avec le contenu existant d’ changelog?

Oui, la skill lit le fichier .md actuel d’ CHANGELOG, crée la section cible si elle n’existe pas et fusionne les nouvelles entrées tout en évitant les doublons.

Les références aux tickets sont-elles obligatoires dans les messages de commit ?

Non, les références aux tickets sont facultatives. Lorsqu’elles sont présentes, elles sont incluses dans l’entrée au format « (#123) ». Les références multiples sont fusionnées sous la forme « (#123, #124) ».