Automatisieren von Versionshinweisen mit GitHub

  • 5 Minuten

Nachdem Sie gelernt haben, wie Sie Releasetags in Ihrem Repository erstellen und verwalten, erfahren Sie, wie Sie die automatisch generierte Versionshinweisevorlage aus Ihren GitHub-Versionen konfigurieren.

Sie können einen Überblick über den Inhalt einer Version erstellen und auch Ihre automatisierten Versionshinweise anpassen.

Es ist möglich, Labels zu verwenden, um benutzerdefinierte Kategorien zu erstellen und Pull-Anfragen zu organisieren, indem Sie bestimmte Labels und Benutzer in die Ausgabe ein- oder ausschließen.

Erstellen automatisch generierter Versionshinweise

Beim Konfigurieren Ihrer Version wird die Option "Automatisches Generieren von Versionshinweisen" angezeigt, um alle Änderungen zwischen Ihrem Tag und der letzten Version einzuschließen. Wenn Sie nie eine Version erstellt haben, besteht sie aus allen Änderungen aus Ihrem Repository.

Screenshot zum Erstellen von Versionshinweisen von GitHub.

Sie können auswählen, ob Sie es anpassen oder so belassen möchten.

Konfiguration 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 zum Erstellen einer neuen Datei auf GitHub.

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

    Screenshot zum Erstellen der Datei release.yml auf GitHub.

  3. Geben Sie in YAML die Pullanforderungsbezeichnungen und Autoren an, die Sie von dieser Version ausschließen möchten. Sie können auch neue Kategorien erstellen und die Pull-Request-Labels in jeder auflisten. Weitere Informationen zu Konfigurationsoptionen finden Sie unter Automatisch generierten Versionshinweisen – 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. Speichern Sie die neue Datei.

    Screenshot über das Committen einer neuen Datei auf GitHub.

  5. Versuchen Sie, ein neues Release zu erstellen, und klicken Sie auf + automatisch generierte Versionshinweise, um die Struktur der Vorlage zu sehen.

Weitere Informationen finden Sie unter: