Automatiser les notes de publication avec GitHub

5 minutes

Une fois que vous avez appris à créer et gérer des étiquettes de version dans votre dépôt, vous pouvez apprendre à configurer le modèle de notes de publication généré automatiquement à partir de vos versions GitHub.

Vous pouvez générer une vue d’ensemble du contenu d’une version et é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 demandes de tirage. Vous pouvez inclure ou exclure des étiquettes ou des utilisateurs spécifiques dans la sortie.

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

Quand vous configurez votre version, vous voyez l’option Générer automatiquement les notes de publication, qui permet d’inclure toutes les modifications entre votre étiquette et la dernière version. Si vous n’avez jamais créé de version, elle est constituée de toutes les modifications de votre référentiel.

Capture d’écran de la création de notes de publication à partir de GitHub.

Vous pouvez choisir de les personnaliser ou les laisser telles quelles.

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

Vous pouvez personnaliser le modèle des notes de publication générées automatiquement en utilisant les étapes suivantes.

Accédez à votre dépôt et créez un fichier.
Vous pouvez utiliser le nom .github/release.yml pour créer le fichier release.yml dans le répertoire .github.
Spécifiez dans le fichier YAML les étiquettes de demande de tirage et les auteurs que vous voulez exclure de cette version. Vous pouvez également créer des catégories et lister les étiquettes de demande de tirage dans chacune d’elles. Pour plus d’informations sur les options de configuration, consultez 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:
        - *
```
Commitez votre nouveau fichier.
Essayez de créer une version et cliquez sur + Générer automatiquement les notes de publication pour voir la structure du modèle.

Pour plus d'informations, consultez les pages suivantes :

Continuer

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

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

Commentaires