Skip to main content
Nous publions des mises à jour fréquentes de notre documentation, et la traduction de cette page peut encore être en cours. Pour obtenir les informations les plus actuelles, consultez la documentation anglaise.

Cette version de GitHub Enterprise ne sera plus disponible le 2023-03-15. Aucune publication de correctifs n’est effectuée, même pour les problèmes de sécurité critiques. Pour de meilleures performances, une sécurité améliorée et de nouvelles fonctionnalités, effectuez une mise à niveau vers la dernière version de GitHub Enterprise. Pour obtenir de l’aide sur la mise à niveau, contactez le support GitHub Enterprise.

Notes de publication générées automatiquement

Vous pouvez générer automatiquement des notes de publication pour vos versions GitHub

Qui peut utiliser cette fonctionnalité

Repository collaborators and people with write access to a repository can generate and customize automated release notes for a release.

À propos des notes de publication générées automatiquement

Les notes de publication générées automatiquement offrent une alternative automatisée à l’écriture manuelle des notes de publication pour vos versions GitHub. Avec des notes de publication générées automatiquement, vous pouvez rapidement générer une vue d’ensemble du contenu d’une version. Les notes de publication générées automatiquement incluent une liste de demandes de tirage (pull request) fusionnées, une liste de contributeurs à la version et un lien vers un journal de modification complet.

Vous pouvez également personnaliser vos notes de publication automatisées en utilisant des étiquettes pour créer des catégories personnalisées afin d’y organiser les demandes de tirage de votre choix, et exclure certaines étiquettes et utilisateurs dans la sortie.

Création de notes de publication générées automatiquement pour une nouvelle version

  1. Dans your GitHub Enterprise Server instance, accédez à la page principale du dépôt. 1. À droite de la liste des fichiers, cliquez sur Mises en production. Section Mises en production dans la barre latérale droite
  2. Cliquez sur Créer un brouillon d’une nouvelle version. Bouton Brouillon de versions
  3. Tapez un numéro de version pour votre version. Vous pouvez aussi sélectionner une étiquette existante. Version étiquetée des mises en production
  4. Si vous avez créé une étiquette, utilisez le menu déroulant pour sélectionner la branche qui contient le projet à publier. Branche étiquetée des mises en production
  5. En haut à droite de la zone de texte de description, cliquez sur Générer automatiquement des notes de publication. Générer automatiquement des notes de publication
  6. Passez en revue les notes générées pour vérifier qu’elles comprennent toutes (et uniquement) les informations que vous voulez ajouter.
  7. Vous pouvez aussi ajouter des fichiers binaires comme des programmes compilés dans votre mise en production, pour ce faire, faites un glisser-déposer des fichiers dans la zone Fichiers binaires, ou sélectionnez-les manuellement. Fourniture d’un DMG avec la mise en production
  8. Pour avertir les utilisateurs que la mise en production n’est pas prête pour la production et peut être instable, sélectionnez Il s’agit d’une préversion. Case à cocher pour marquer une mise en production comme préversion
  9. Si vous êtes prêt à rendre publique votre mise en production, cliquez sur Publier la mise en production. Pour travailler sur la mise en production par la suite, cliquez sur Enregistrer le brouillon. Boutons Publier la version et Enregistrer un brouillon de la version

Configuration des notes de publication générées automatiquement

  1. Dans your GitHub Enterprise Server instance, accédez à la page principale du dépôt. 1. Au-dessus de la liste des fichiers, en utilisant la liste déroulante Ajouter un fichier, cliquez sur Créer un fichier. « Créer un fichier » dans la liste déroulante « Ajouter un fichier »
  2. Dans le champ de nom de fichier, tapez .github/release.yml pour créer le fichier release.yml dans le répertoire .github. Créer un fichier
  3. Dans le fichier, en utilisant les options de configuration ci-dessous, spécifiez dans le YAML les étiquettes et les auteurs de demande de tirage à exclure de cette version. Vous pouvez également créer des catégories et lister les étiquettes de demande de tirage qui doivent être ajoutées dans chacune d’elles.

Options de configuration

ParamètreDescription
changelog.exclude.labelsListe d’étiquettes qui excluent une demande de tirage dans les notes de publication.
changelog.exclude.authorsListe des descripteurs de connexion d’utilisateur ou de bot dont les demandes de tirage doivent être exclues des notes de publication.
changelog.categories[*].titleObligatoire. Titre d’une catégorie de changements dans les notes de publication.
changelog.categories[*].labelsObligatoire. Étiquettes qui qualifient une demande de tirage pour cette catégorie. Utilisez * comme « fourre-tout » pour les demandes de tirage qui ne correspondent à aucune des catégories précédentes.
changelog.categories[*].exclude.labelsListe d’étiquettes qui excluent une demande de tirage dans cette catégorie.
changelog.categories[*].exclude.authorsListe des descripteurs de connexion d’utilisateur ou de bot dont les demandes de tirage doivent être exclues de cette catégorie.

Exemples de configurations

Configuration d’un référentiel qui étiquette les versions SemVer

YAML
# .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:
        - "*"

Configuration d’un référentiel qui ne balise pas les demandes de tirage, mais dans lequel nous voulons séparer les demandes de tirage automatisées Dependabot dans les notes de publication (labels: '*' est nécessaire pour afficher une catégorie catchall)

YAML
# .github/release.yml

changelog:
  categories:
    - title: 🏕 Features
      labels:
        - '*'
      exclude:
        labels:
          - dependencies
    - title: 👒 Dependencies
      labels:
        - dependencies

Pour aller plus loin