Informationen zu automatisch generierten Versionshinweisen
Automatisch generierte Versionshinweise bieten eine automatisierte Alternative zum manuellen Schreiben von Versionshinweisen für deine GitHub-Releases. Mit automatisch generierten Versionshinweisen kannst du schnell einen Überblick über den Inhalt einer Version erstellen. Automatisch generierte Versionshinweise umfassen eine Liste der zusammengeführten Pull Requests, eine Liste der Mitwirkenden an der Version und einen Link zu einem vollständigen Änderungsprotokoll.
Du kannst auch deine automatisierten Versionshinweise anpassen, indem du Beschriftungen verwendest, um benutzerdefinierte Kategorien zu erstellen, um Pull Requests zu strukturieren, die du einschließen möchtest, und um bestimmte Bezeichnungen und Benutzer*innen aus der Ausgabe auszuschließen.
Erstellen von automatisch generierten Versionshinweisen für ein neues Release
- Navigiere auf your GitHub Enterprise Server instance zur Hauptseite des Repositorys. 1. Klicke rechts neben der Liste der Dateien auf Releases.
- Klicke auf Neues Release entwerfen.
- Geben eine Versionsnummer für dein Release ein. Alternativ kannst du ein vorhandenes Tag auswählen.
- Wenn du ein neues Tag erstellt hast, verwende das Dropdownmenü, um den Branch auszuwählen, der das zu veröffentlichende Projekt enthält.
- Klicke rechts neben dem Beschreibungstextfeld auf Versionshinweise automatisch generieren.
- Überprüfe die generierten Notizen, um sicherzustellen, dass sie alle (und nur) die Informationen enthalten, die du einschließen möchtest.
- Um optional binäre Dateien wie kompilierte Programme in deinen Release einzubinden, ziehe die Dateien mit Drag-and-Drop herüber oder wähle die Dateien manuell im Feld für Binärdateien.
- Um Benutzer*innen darüber zu informieren, dass das Release nicht produktionsbereit und möglicherweise instabil ist, wähle Dies ist eine Vorabversion aus.
- Wenn du dein Release veröffentlichen möchtest, klicke auf Release veröffentlichen. Wenn du später an dem Release arbeiten möchtest, klicke auf Entwurf speichern.
Konfigurieren von automatisch generierten Versionshinweisen
- Navigiere auf your GitHub Enterprise Server instance zur Hauptseite des Repositorys. 1. Klicke oberhalb der Dateiliste im Dropdownmenü Datei hinzufügen auf Neue Datei erstellen.
- Gib
.github/release.yml
im Dateinamenfeld ein, um die Dateirelease.yml
im Verzeichnis.github
zu erstellen. - Gib in der Datei mithilfe der nachstehenden Konfigurationsoptionen in YAML die Pull-Request-Bezeichnungen und Autoren an, die du aus diesem Release ausschließen möchtest. Du kannst auch neue Kategorien erstellen und die Pull-Request-Bezeichnungen auflisten, die in jede dieser Kategorien einbezogen werden sollen.
Konfigurationsoptionen
Parameter | BESCHREIBUNG |
---|---|
changelog.exclude.labels | Eine Liste von Bezeichnungen, die ausschließen, dass ein Pull Request in den Versionshinweisen angezeigt wird. |
changelog.exclude.authors | Eine Liste der Benutzer*innen- oder Bot-Anmeldehhandles, deren Pull Requests aus Versionshinweisen ausgeschlossen werden sollen. |
changelog.categories[*].title | Erforderlich. Der Titel einer Kategorie von Änderungen in Versionshinweisen. |
changelog.categories[*].labels | Erforderlich. Bezeichnungen, die einen Pull Request für diese Kategorie qualifizieren. Verwende * als Catch-All für Pull Requests, die keinen der vorherigen Kategorien entsprechen. |
changelog.categories[*].exclude.labels | Eine Liste der Bezeichnungen, die eine Pull Request ausschließen, die in dieser Kategorie angezeigt wird. |
changelog.categories[*].exclude.authors | Eine Liste der Benutzer*innen- oder Bot-Anmeldehhandles, deren Pull Requests aus dieser Kategorie ausgeschlossen werden sollen. |
Beispielkonfigurationen
Eine Konfiguration für ein Repository, das SemVer-Releases kennzeichnet
# .github/release.yml
changelog:
exclude:
labels:
- ignore-for-release
authors:
- octocat
categories:
- title: Breaking Changes 🛠
labels:
- Semver-Major
- breaking-change
- title: Exciting New Features 🎉
labels:
- Semver-Minor
- enhancement
- title: Other Changes
labels:
- "*"
Eine Konfiguration für ein Repository, das keine Pull Requests taggt, aber in der automatisierte Dependabot-Pull Requests in Versionshinweisen getrennt werden sollen (labels: '*'
ist erforderlich, um eine Catchall-Kategorie anzuzeigen)
# .github/release.yml
changelog:
categories:
- title: 🏕 Features
labels:
- '*'
exclude:
labels:
- dependencies
- title: 👒 Dependencies
labels:
- dependencies