Automatisieren von Versionshinweisen mit GitHub

  • 5 Minuten

Nachdem Sie gelernt haben, wie Sie Releasetags in Ihrem Repository erstellen und verwalten können, erfahren Sie, wie Sie die automatisch generierte Vorlage für Versionshinweise für Ihre GitHub-Releases konfigurieren können.

Sie können eine Übersicht über den Inhalt eines Release erstellen und Ihre automatisierten Versionshinweise individuell anpassen.

Es ist möglich, mithilfe von Bezeichnungen benutzerdefinierte Kategorien zu erstellen, um Pull Requests zu organisieren, die bestimmte Bezeichnungen und Benutzer in die Ausgabe einbeziehen oder diese von ihr ausschließen sollen.

Erstellen von automatisch generierten Versionshinweisen

Bei der Konfiguration Ihres Release wird die Option „Versionshinweise automatisch generieren“ angezeigt, um alle Änderungen zwischen Ihrem Tag und dem letzten Release zu erfassen. Wenn Sie noch nie ein Release erstellt haben, bestehen die Versionshinweise aus allen Änderungen aus Ihrem Repository.

Screenshot: Erstellen von Versionshinweisen in GitHub.

Sie können auswählen, ob Sie den Inhalt anpassen oder unverändert beibehalten möchten.

Konfigurieren der Vorlage für automatisch generierte Versionshinweise

Sie können die Vorlage für die automatische Generierung von Versionshinweisen mithilfe der folgenden Schritte anpassen.

  1. Navigieren Sie zu Ihrem Repository, und erstellen Sie eine neue Datei.

    Screenshot: Erstellen einer neuen Datei in GitHub.

  2. Sie können den Namen .github/release.yml verwenden, um die Datei release.yml im Verzeichnis .github zu erstellen.

    Screenshot: Erstellen der release.yml-Datei in GitHub.

  3. Geben Sie in YAML die Pull-Request-Bezeichnungen und Autoren an, die Sie aus diesem Release ausschließen möchten. Sie können auch neue Kategorien erstellen und die Pull-Request-Bezeichnungen in jeder Kategorie auflisten. Weitere Informationen zu Konfigurationsoptionen finden Sie unter Automatisch generierte Versionshinweise – GitHub-Dokumentation.

    Beispielkonfiguration:

    # .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:
        - *

  4. Committen Sie Ihre neue Datei.

    Screenshot: Committen einer neuen Datei in GitHub.

  5. Versuchen Sie, ein neues Release zu erstellen, und klicken Sie auf + Auto-generate release notes (Versionshinweise automatisch generieren), um die Vorlagenstruktur anzuzeigen.

Weitere Informationen finden Sie unter