Ich bin ein Neuling mit git und ich würde gerne die beste Vorgehensweise kennen, um Tags zu erstellen und ein Changelog zu erzeugen / zu verwalten.
Bis jetzt habe ich immer eine readme.md erstellt und manuell (im Abschnitt "changelog") das wichtigste Feature angegeben
Zum Beispiel:
Version 1.0.1
- Layout in Home
geändert- Diashow in Galerie hinzugefügt
- usw. ..
Wie kann ich ein Changelog (vielleicht im Markdown-Format) mit diesen Merkmalen erstellen?
Ich habe noch keine klare Idee, also sind Vorschläge sehr gut
Vielen Dank im Voraus:)
Es gibt noch keine gemeinsamen Richtlinien. Aber viele gute Regeln werden auf ein Änderungsprotokoll erklärt.
Und wie sie erwähnen:
Lass deine Freunde keine git-Logs in changelogs ablegen.
Und ich stimme voll und ganz zu.
Deshalb habe ich GitHub Changelog Generator erstellt, der ein Changelog nach all diesen Richtlinien generiert.
Eigentlich funktioniert es nur mit GitHub , aber es ist ein gutes Beispiel dafür, wie ein Changelog aussehen sollte.
Es generiert automatisch ein Änderungsprotokoll für Ihre Tags, Probleme, Labels und Pull-Requests.
Beispiel: Dieses Änderungsprotokoll wurde von diesem Skript generiert: CHANGELOG.md
Änderungsprotokoll
1.2.5 (2015-01-15)
Implementierte Erweiterungen:
- Verwenden Sie den Meilenstein, um anzugeben, in welcher Version der Fehler behoben wurde # 22
Fehler behoben:
- Fehler beim Versuch, ein Protokoll für Repo ohne Tags zu generieren # 32
Zusammengefasste Pull-Anforderungen:
Die PrettyPrint-Klasse wird mit Kleinbuchstaben 'pp' # 43 ( schwingen )
unterstützt Unternehmen github über die Befehlszeilenoptionen # 42 (glenlovett )
Ich schlage vor, dass Sie die Änderungen im Änderungsprotokoll immer noch manuell beschreiben.
Leider können Sie über github diff eine Verknüpfung zu generierten Änderungen herstellen. Zum Beispiel das Änderungsprotokoll: Ссылка
Und das diff: Ссылка
Vielleicht möchten Sie sich in den Repositories einiger anderer Referenz-Opensource-Projekte umsehen, in denen viele gute Praktiken gefunden werden können.
Wahrscheinlich ist mein Asnwer zu spät, aber jetzt benutze ich ein erstaunliches Rubin-Juwel, es liest dein Git-Log und teilt es durch Tags, und die Ausgabe wird in Markdown geschrieben, sieh es dir an