Automatisieren von Versionshinweisen mit GitHub

  • 5 Minuten

Nachdem Sie gelernt haben, wie Sie Releasetags in Ihrem Repository erstellen und verwalten, erfahren Sie, wie Sie automatisch generierte Versionshinweise für Ihre GitHub-Versionen einrichten.

Sie können einen Überblick darüber erstellen, was in einer Version enthalten ist, und Sie können auch Ihre automatisierten Versionshinweise anpassen.

Sie können Bezeichnungen verwenden, um benutzerdefinierte Kategorien zu erstellen, um Pullanforderungen zu organisieren. Sie können auch bestimmte Bezeichnungen und Benutzer aus der Ausgabe einschließen oder ausschließen.

Erstellen automatisch generierter Versionshinweise

Bei der Einrichtung 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 zuvor eine Version erstellt haben, enthält sie alle Änderungen aus Ihrem Repository.

Screenshot zum Erstellen von Versionshinweisen von GitHub.

Sie können wählen, ob Sie es anpassen oder es unverändert lassen.

Einrichten einer Vorlage für automatisch generierte Versionshinweise

Sie können die Vorlage für automatisch generierte Versionshinweise anpassen, indem Sie die folgenden Schritte ausführen:

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

    Screenshot zum Erstellen einer neuen Datei auf GitHub.

  2. Verwenden Sie den Namen ".github/release.yml ", um die release.yml Datei im GitHub-Verzeichnis zu erstellen.

    Screenshot zum Erstellen der Datei release.yml auf GitHub.

  3. Schreiben Sie im YAML-Format, das Anforderungsbezeichnungen und Autoren abruft, 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 Setupoptionen 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 des Commits einer neuen Datei in GitHub.

  5. Versuchen Sie, eine neue Veröffentlichung zu erstellen, und wählen Sie + Veröffentlichungshinweise automatisch generieren, um zu sehen, wie die Vorlage funktioniert.

Weitere Informationen finden Sie unter: