Releaseopmerkingen automatiseren met GitHub

  • 5 minuten

Nadat u hebt geleerd hoe u releasetags in uw opslagplaats maakt en beheert, leert u hoe u automatisch gegenereerde releaseopmerkingen instelt voor uw GitHub-releases.

U kunt een overzicht maken van wat er is opgenomen in een release en u kunt ook uw geautomatiseerde releaseopmerkingen aanpassen.

U kunt labels gebruiken om aangepaste categorieën te maken om pull-aanvragen te organiseren. U kunt er ook voor kiezen om specifieke labels en gebruikers op te nemen of uit te sluiten van de uitvoer.

Automatisch gegenereerde releasenotities maken

Bij het instellen van uw release hebt u de optie 'Opmerkingen bij de release automatisch genereren' om alle wijzigingen tussen uw tag en de laatste release op te nemen. Als u nog nooit eerder een release hebt gemaakt, worden alle wijzigingen uit uw opslagplaats opgenomen.

Schermopname van het maken van releaseopmerkingen vanuit GitHub.

U kunt ervoor kiezen om het aan te passen of te laten zoals het is.

Sjabloon voor automatisch gegenereerde releaseopmerkingen instellen

U kunt de sjabloon voor automatisch gegenereerde releaseopmerkingen aanpassen door de volgende stappen uit te voeren:

  1. Ga naar uw opslagplaats en maak een nieuw bestand.

    Schermopname van het maken van een nieuw bestand op GitHub.

  2. Gebruik de naam .github/release.yml voor het maken van het bestand release.yml in de directory .github.

    Schermopname van het maken van release.yml bestand op GitHub.

  3. Schrijf in YAML-indeling, waarmee labels en auteurs worden opgehaald die u wilt uitsluiten van deze release. U kunt ook nieuwe categorieën maken en de pull-aanvraaglabels in elke categorie weergeven. Zie Automatisch gegenereerde releaseopmerkingen - GitHub Docs voor meer informatie over installatieopties.

    Voorbeeldconfiguratie:

    # .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. Voer het nieuwe bestand door.

    Schermopname van het doorvoeren van een nieuw bestand op GitHub.

  5. Probeer een nieuwe release te maken en selecteer + Opmerkingen bij de release automatisch genereren om te zien hoe de sjabloon werkt.

Zie voor meer informatie: