Automatiser les notes de publication avec GitHub

  • 5 minutes

Après avoir appris à créer et gérer des balises de mise en production dans votre référentiel, vous allez apprendre à configurer des notes de publication générées automatiquement pour vos versions GitHub.

Vous pouvez créer une vue d’ensemble de ce qui est inclus dans une version, et vous pouvez également personnaliser vos notes de publication automatisées.

Vous pouvez utiliser des étiquettes pour créer des catégories personnalisées afin d'organiser les pull requests. Vous pouvez également choisir d’inclure ou d’exclure des étiquettes et des utilisateurs spécifiques de la sortie.

Création de notes de publication générées automatiquement

Lors de la configuration de votre version, vous avez la possibilité de « Générer automatiquement les notes de publication » pour inclure toutes les modifications entre votre balise et la dernière version. Si vous n’avez jamais créé une version antérieure, elle inclut toutes les modifications de votre référentiel.

Capture d’écran montrant comment créer des notes de publication à partir de GitHub.

Vous pouvez choisir de le personnaliser ou de le laisser tel qu’il est.

Configuration du modèle de notes de publication généré automatiquement

Vous pouvez personnaliser le modèle de notes de publication générées automatiquement en procédant comme suit :

  1. Accédez à votre référentiel et créez un fichier.

    Capture d’écran de la création d’un fichier sur GitHub.

  2. Utilisez le nom .github/release.yml pour créer le fichier release.yml dans le répertoire .github .

    Capture d’écran de la création d’un fichier release.yml sur GitHub.

  3. Écrivez au format YAML, qui extrait les étiquettes de demande et les auteurs que vous souhaitez exclure de cette version. Vous pouvez également créer de nouvelles catégories et répertorier les labels de pull request dans chacune d'elles. Pour plus d’informations sur les options de configuration, consultez les notes de publication générées automatiquement - GitHub Docs.

    Exemple de configuration :

    # .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. Validez votre nouveau fichier.

    Capture d’écran de la validation du nouveau fichier sur GitHub.

  5. Essayez de créer une nouvelle version et sélectionnez + Notes de publication de génération automatique pour voir comment fonctionne le modèle.

Pour plus d’informations, consultez :