Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Beide Seiten der vorigen RevisionVorhergehende Überarbeitung | |||
changelog-generator [2023/09/18 00:12] – 46.114.222.68 | changelog-generator [2023/11/22 22:13] (aktuell) – gelöscht weis | ||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
- | **Abstract: | ||
- | |||
- | // | ||
- | |||
- | **Verantwortliche: | ||
- | |||
- | **Ressourcen: | ||
- | |||
- | Die Idee zum Skript enstand aus dem Bedarf, bei öffentlichen Repositories einen unkomplizierten Weg zu finden, Entwicklungsvorgänge anhand eines Logs (Changelog) zu dokumentieren und sauber zu formatieren. Mit Hilfe der Verwendung von [[https:// | ||
- | |||
- | Ziel ist es, diese verschiedenen Parameter (//type//: Kategorie von Commits, //scope//: deren Umfangsbereich, | ||
- | |||
- | Das Skript steht in Python, ist objektorientiert implementiert und noch nicht veröffentlicht, | ||
- | |||
- | {{: | ||
- | |||
- | # Beispiel-Changelog (vgl. Beitragsbild) | ||
- | |||
- | ## Version 1.0 | ||
- | |||
- | ### Features | ||
- | - *scope* | ||
- | - message (short-hash) | ||
- | |||
- | ### Fixes | ||
- | - *scope* | ||
- | - message (short-hash) | ||
- | |||
- | ### Other | ||
- | - *scope* | ||
- | - (type) message (short-hash) | ||
- | |||
- | ### Non-conform commits | ||
- | - full message (short-hash) | ||
- | |||
- | |||
- | Commits werden nach den Types der // | ||
- | In der aktuellen Entwicklungsversion sind diese Einstellungen noch statisch, in Zukunft sollen sie dynamisch über Kommandozeilenparameter flexibler gestaltet werden können. Das Programm wird ohne Parameter aufgerufen: | ||
- | |||
- | |||
- | python changelog-generator.py | ||
- | |||
- | |||
- | Daraufhin fragt das Skript den Pfad zum git-Repository ab und wo der Changelog gespeichert werden soll. | ||