Comment générer des notes de mise à jour ?

Question

[Question]
Est-ce que quelqu'un produit des notes de version via un processus automatisé ? Si oui, comment. En particulier avec des services d'intégration continue. Utilisez-vous simplement un script pour analyser les fichiers journaux des problèmes corrigés pour cette version afin de créer le fichier texte approprié ?

[Contexte]
Récemment, j'ai mis en place l'intégration continue pour mes projets de loisirs. Dans le cadre de cette intégration, j'ai intégré des rapports de suivi des problèmes dans mes constructions. Cependant, pour les versions, je souhaite faire la même chose et obtenir un fichier de notes de version similaire au fichier nhibernate release notes.txt que je trouve très propre.

[Exemple]

Version 1.2.1

Correction d'un bug :

* [ID-1] - The system doesn't accept valid usernames

Améliorations :

* [ID-2] - Saving the file takes 3 minutes when it should take a few seconds. 

Nouvelles fonctionnalités :

* [ID-3] - Allow users to refresh the page using the F5 key.

Tâche accomplie :

* [ID-4] - Document undocumented configuration properties.

Answer 1

En supposant que les développeurs ne soient pas des corsaires et qu'ils fassent partie d'une équipe qui reçoit des missions et les exécute, une liste de ce qui a été fait et qui devrait faire partie de l'UAT est la note de publication de facto. Les listes de modifications de fichiers et autres ne sont pas pertinentes et peuvent être extraites facilement du contrôle de la source.

Étant donné qu'il est extrêmement difficile d'appliquer une politique selon laquelle les développeurs vérifient les codes comportant des numéros de problèmes, je ne m'en préoccupe pas. Je pose la question lors de l'examen du code. Je garde également une liste de ce sur quoi nous travaillons. Les choses qui sont terminées sont ajoutées au journal juste avant que les commandes mvn release:prepare ne soient exécutées. Je les transmets ensuite à l'AQ et à l'UAT.

Il est peu probable que cette méthode puisse être appliquée à des centaines de numéros par semaine. Dans ce cas, il est préférable d'utiliser un système plus robuste.

Answer 2

Vous pouvez utiliser un outil comme doxygen pour le faire, mais il est assez fastidieux de commenter de la manière prévue par doxygen. J'obtiens généralement ces commentaires à la main.

Je n'en suis pas sûr, mais un produit comme FogBugz ne pourrait-il pas faire la même chose ?

Answer 3

Pour ceux qui travaillent avec .NET et TFS, vous pouvez utiliser TfsChangeLog pour générer automatiquement vos notes de mise à jour.

TFS ChangeLog permet aux utilisateurs de Team Foundation Server (TFS) d'extraire les informations relatives aux Changesets et aux WorkItems associés au format XML qui est transformé en HTML. TFSChangeLog produit automatiquement le journal des changements et les notes de mise à jour en fonction de la plage de changements sélectionnée.

TFS conserve l'historique des versions des fichiers par le biais des changesets enregistrés et des WorkItems associés. Ces informations exactes seront utilisées pour générer des notes de version. Le gestionnaire de configuration/version peut utiliser les champs de données du système ou les champs personnalisés pour générer le contenu des notes de mise à jour. Le puissant support XSLT 2.0 pour la transformation des données à partir du format XML brut est fourni d'emblée, ce qui ouvre certainement la possibilité de générer des données dans différents formats. La prise en charge de XSLT 2.0 permet d'appliquer très facilement des conditions de filtrage aux résultats des transformations, selon les besoins des utilisateurs.

Answer 4

J'ai été confronté à un problème similaire récemment et j'ai amélioré un plugin maven existant pour faire cela.

Si vous utilisez Git pour le contrôle des sources et que vous construisez votre projet à l'aide de Maven, cela peut être une bonne solution : https://github.com/pankajtandon/maven-git-commit-id-plugin#releasenotes