Points clés
- Catégorie
- Development
- Types d’entrée
- textarea, select, checkbox
- Type de sortie
- json
- Couverture des échantillons
- 4
- API disponible
- Yes
Vue d’ensemble
L'Extracteur de Journal des Modifications est un outil puissant conçu pour analyser et convertir automatiquement vos notes de version et journaux de commits en données JSON structurées, facilitant ainsi leur intégration dans vos outils de documentation ou vos pipelines de déploiement.
Quand l’utiliser
- •Pour transformer des fichiers texte de type 'Keep a Changelog' en données exploitables par une API.
- •Lors de la standardisation de vos notes de version issues de commits Git conventionnels.
- •Pour générer des statistiques sur la fréquence et la nature des mises à jour de vos projets logiciels.
Comment ça marche
- •Collez le contenu de votre journal des modifications ou de vos notes de version dans la zone de saisie.
- •Sélectionnez le format source ou laissez l'outil détecter automatiquement la structure utilisée.
- •Activez l'option d'inclusion des descriptions pour conserver les détails textuels de chaque changement.
- •Récupérez le résultat au format JSON structuré, prêt à être utilisé dans vos applications.
Cas d’usage
Exemples
1. Conversion de Conventional Commits
Développeur DevOps- Contexte
- Une équipe utilise les Conventional Commits pour gérer ses versions et souhaite afficher les dernières mises à jour sur leur portail interne.
- Problème
- Les messages de commits bruts sont difficiles à lire pour les utilisateurs finaux et non structurés pour le site web.
- Comment l’utiliser
- Copier l'historique des commits, sélectionner 'Conventional Commits' dans le menu déroulant et extraire le JSON.
- Résultat
- Un fichier JSON propre classant les changements par type (feat, fix, chore) et par version, prêt à être affiché sur le portail.
2. Standardisation de Keep a Changelog
Responsable Produit- Contexte
- Le fichier CHANGELOG.md du projet est devenu trop volumineux et complexe à maintenir manuellement pour les rapports de conformité.
- Problème
- Besoin d'extraire des statistiques précises sur le nombre de correctifs de sécurité par version.
- Comment l’utiliser
- Importer le contenu du fichier Markdown, choisir le format 'Keep a Changelog' et générer le JSON.
- Résultat
- Extraction structurée permettant de compter instantanément les entrées dans la catégorie 'Sécurité' pour chaque version publiée.
Tester avec des échantillons
textHubs associés
FAQ
Quels formats de journaux sont pris en charge ?
L'outil prend en charge les formats 'Keep a Changelog', 'Conventional Commits' et les notes de version 'GitHub Releases'.
L'outil peut-il détecter automatiquement le format ?
Oui, l'option de détection automatique identifie le style de votre texte pour appliquer les règles d'extraction appropriées.
Quelles données sont extraites ?
L'outil extrait les numéros de version, les dates, les catégories de changements (ajout, correction, etc.) et les descriptions détaillées.
Le format de sortie est-il toujours du JSON ?
Oui, l'outil génère systématiquement un objet JSON structuré pour garantir une compatibilité maximale avec vos outils de développement.
Puis-je exclure les descriptions longues ?
Oui, vous pouvez décocher l'option 'Inclure les Descriptions Complètes' pour obtenir un fichier JSON plus léger contenant uniquement les métadonnées.