Skip to main content

Commentaire sur un problème lors de l’ajout d’une étiquette

Vous pouvez utiliser GitHub Actions pour commenter automatiquement les problèmes lorsqu’une étiquette spécifique est appliquée.

Remarque : Les exécuteurs hébergés sur GitHub ne sont pas pris en charge sur GitHub Enterprise Server. Vous pouvez voir plus d’informations sur le support futur planifié dans la GitHub public roadmap.

Introduction

Ce tutoriel montre comment utiliser l’action peter-evans/create-or-update-comment pour commenter un problème lors de l’application d’une étiquette spécifique. Par exemple, quand l’étiquette help-wanted est ajoutée à un problème, vous pouvez ajouter un commentaire pour encourager les contributeurs à travailler sur le problème.

Dans le tutoriel, vous allez d’abord créer un fichier de workflow qui utilise l’action peter-evans/create-or-update-comment. Ensuite, vous personnaliserez le workflow en fonction de vos besoins.

Création du workflow

  1. Choisissez un dépôt où vous souhaitez appliquer ce workflow de gestion de projet. Vous pouvez utiliser un dépôt existant auquel vous avez accès en écriture ou en créer un nouveau. Pour plus d’informations sur la création d’un dépôt, consultez « Création d’un dépôt ».

  2. Dans votre dépôt, créez un fichier nommé .github/workflows/YOUR_WORKFLOW.yml, en YOUR_WORKFLOW remplaçant par un nom de votre choix. Il s’agit d’un fichier de workflow. Pour plus d’informations sur la création de fichiers sur GitHub, consultez « Création de fichiers ».

  3. Copiez le contenu YAML suivant dans votre fichier de workflow.

    YAML
    # <a name="this-workflow-uses-actions-that-are-not-certified-by-github"></a>Ce workflow utilise des actions qui ne sont pas certifiées par GitHub.
    # <a name="they-are-provided-by-a-third-party-and-are-governed-by"></a>Elles sont fournies par un tiers et régies par
    # <a name="separate-terms-of-service-privacy-policy-and-support"></a>des conditions d’utilisation du service, une politique de confidentialité et un support distincts.
    # <a name="documentation"></a>documentation en ligne.
    
    # <a name="github-recommends-pinning-actions-to-a-commit-sha"></a>GitHub recommande d’épingler les actions à un SHA de commit.
    # <a name="to-get-a-newer-version-you-will-need-to-update-the-sha"></a>Pour obtenir une version plus récente, vous devez mettre à jour le SHA.
    # <a name="you-can-also-reference-a-tag-or-branch-but-the-action-may-change-without-warning"></a>Vous pouvez également référencer une balise ou une branche, mais l’action peut changer sans avertissement.
    
    name: Add comment
    on:
      issues:
        types:
          - labeled
    jobs:
      add-comment:
        if: github.event.label.name == 'help-wanted'
        runs-on: ubuntu-latest
        permissions:
          issues: write
        steps:
          - name: Add comment
            uses: peter-evans/create-or-update-comment@a35cf36e5301d70b76f316e867e7788a55a31dae
            with:
              issue-number: ${{ github.event.issue.number }}
              body: |
                This issue is available for anyone to work on. **Make sure to reference this issue in your pull request.** :sparkles: Thank you for your contribution! :sparkles:
  4. Personnalisez les paramètres dans votre fichier de workflow :

    • Remplacez help-wanted dans if: github.event.label.name == 'help-wanted' par l’étiquette sur laquelle vous souhaitez agir. Si vous souhaitez agir sur plusieurs étiquettes, séparez les conditions avec ||. Par exemple, if: github.event.label.name == 'bug' || github.event.label.name == 'fix me' commentera chaque fois que les étiquettes bug ou fix me seront ajoutées à un problème.
    • Modifiez la valeur de body pour le commentaire que vous souhaitez ajouter. Le markdown adapté à GitHub est pris en charge. Pour plus d’informations sur le markdown, consultez « Syntaxe de base pour l’écriture et la mise en forme  ».
  5. Commitez votre fichier de workflow dans la branche par défaut de votre dépôt. Pour plus d’informations, consultez « Création de fichiers ».

Test du workflow

Chaque fois qu’un problème dans votre dépôt est étiqueté, ce workflow s’exécute. Si l’étiquette ajoutée est l’une de celles que vous avez spécifiées dans votre fichier de workflow, l’action peter-evans/create-or-update-comment ajoute le commentaire que vous avez spécifié au problème.

Testez votre workflow en appliquant votre étiquette spécifiée à un problème.

  1. Ouvrez un problème dans votre dépôt. Pour plus d’informations, consultez « Création d’un problème ».
  2. Étiquetez le problème avec l’étiquette spécifiée dans votre fichier de workflow. Pour plus d’informations, consultez « Gestion des étiquettes ».
  3. Pour voir l’exécution du workflow déclenchée par l’étiquetage du problème, affichez l’historique des exécutions de votre workflow. Pour plus d’informations, consultez « Affichage de l’historique des exécutions de workflows ».
  4. Une fois le workflow terminé, le problème que vous avez étiqueté doit avoir un commentaire ajouté.

Étapes suivantes