Changements de version : notes de publication claires générées
Des données de modifications structurées sont rapidement converties en notes de publication cohérentes grâce à ce workflow. Les informations sont reçues via un webhook, vérifiées puis automatiquement formatées en Markdown. Les changements sont regroupés par type (feature, fix, maintenance) et les changements majeurs sont mis en avant. Les équipes de développement bénéficient d'une documentation fiable, adaptable et conforme à leurs standards.
Les équipes de développement disposent avec ce workflow d'un moyen automatisé pour générer des notes de publication à partir de données de modifications structurées. Le processus débute par une requête POST vers un endpoint webhook, qui attend un tableau de modifications comprenant type, title et, en option, issue et breaking. Les entrées sont contrôlées pour leur complétude et la validité des types (feature, fix, maintenance). Lorsque les données sont valides, les modifications sont regroupées et un document Markdown est généré, mettant en avant les nouveautés et les changements majeurs. Les entrées erronées ou incomplètes reçoivent un message d'erreur explicite. La sortie peut être utilisée directement ou intégrée dans d'autres systèmes. Pour sécuriser l'accès, l'authentification du webhook doit être activée séparément dans n8n. L'exécution et le stockage des données respectent la configuration n8n. Ce workflow est particulièrement adapté aux équipes publiant régulièrement des notes de version et recherchant cohérence et efficacité. Le format peut être adapté aux standards de chaque équipe.
Image générée par IA
Installation
1. Importez le workflow dans n8n.
2. Sélectionnez le nœud Webhook et lancez le listener de test.
3. Copiez l'URL de test affichée pour le webhook.
4. Envoyez une requête POST avec Content-Type application/json et un corps adapté à cette URL de test (voir exemple ci-dessous).
5. Vérifiez la réponse et, en cas de succès, publiez/activez le workflow.
6. Après activation, utilisez l'URL de production du nœud Webhook.
7. Configurez l'authentification du webhook dans n8n pour sécuriser l'accès.
Utilisation
Exemple de requête valide :
```json
{
"changes": [
{"type": "feature", "title": "Neue Benutzeroberfläche", "issue": "#123"},
{"type": "fix", "title": "Login-Fehler behoben"},
{"type": "maintenance", "title": "Abhängigkeiten aktualisiert", "breaking": true}
]
}
```
Réponse attendue :
```json
{
"status": "success",
"groups": {
"feature": [
{"type": "feature", "title": "Neue Benutzeroberfläche", "issue": "#123"}
],
"fix": [
{"type": "fix", "title": "Login-Fehler behoben"}
],
"maintenance": [
{"type": "maintenance", "title": "Abhängigkeiten aktualisiert", "breaking": true}
]
},
"breaking": [
{"type": "maintenance", "title": "Abhängigkeiten aktualisiert", "breaking": true}
],
"markdown": "# Release Notes\n\n## feature\n- Neue Benutzeroberfläche (#123)\n\n## fix\n- Login-Fehler behoben\n\n## maintenance\n- Abhängigkeiten aktualisiert\n\n## Breaking Changes\n- Abhängigkeiten aktualisiert"
}
```
Cas d'erreur (tableau changes vide) :
```json
{
"changes": []
}
```
Réponse :
```json
{
"status": "error",
"message": "changes muss ein nicht-leeres Array sein."
}
```
Statut HTTP : 200 (en cas de succès), 200 (en cas d'erreur, car implémenté explicitement ainsi)
Remarques :
- Les champs type (feature, fix, maintenance) et title sont obligatoires.
- Optionnel : issue (ex. numéro de ticket), breaking (true/false).
- L'authentification du webhook doit être activée séparément dans n8n.
- Les données d'exécution peuvent être stockées dans n8n ; conservation et accès selon la configuration n8n.
Connexions et APIs nécessaires
Connexions API
Aucun identifiant API enregistré n'a été détecté dans le JSON du workflow. Vérifiez tout de même les webhooks, systèmes cibles, identifiants et la protection des données avant l'activation.
Nœuds
WebhookCodeRespond to Webhook
Test fonctionnel isolé réussi
Test fonctionnel isolé facultatif
Le flux de données isolé a été testé sans services externes ni identifiants.
✓ 5 tests réussisAfficher les cas testésMasquer les cas testés
✓ Cas normal avec données complètesVérifie le parcours standard complet avec des données d'exemple valides.Test fonctionnel isolé réussi✓ Variante ou cas limiteVérifie une variante valide ou un cas limite important.Test fonctionnel isolé réussi✓ Règle de traitement supplémentaireVérifie la règle de traitement métier supplémentaire de ce workflow.Test fonctionnel isolé réussi✓ Entrée invalide ou incomplèteVérifie que les données invalides ou incomplètes sont rejetées de façon contrôlée.Test fonctionnel isolé réussi✓ Entrée videVérifie qu'une requête vide reçoit une réponse contrôlée.Test fonctionnel isolé réussi
