Ajout d’étiquettes à des problèmes

Introduction

Ce tutoriel montre comment utiliser la GitHub CLI dans un workflow pour étiqueter les problèmes nouvellement ouverts ou rouverts. Par exemple, vous pouvez ajouter l’étiquette triage chaque fois qu’un problème est ouvert ou rouvert. Ensuite, vous pouvez voir tous les problèmes qui doivent être triés en filtrant les problèmes à l’aide de l’étiquette triage.

La GitHub CLI vous permet d’utiliser facilement l’API GitHub dans un workflow.

Dans le tutoriel, vous allez d’abord créer un fichier de flux de travail qui utilise les GitHub CLI. 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 nouveaux fichiers dans GitHub, consultez « Création de fichiers ».

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

   YAML

   name: Label issues
   on:
     issues:
       types:
         - reopened
         - opened
   jobs:
     label_issues:
       runs-on: ubuntu-latest
       permissions:
         issues: write
       steps:
         - run: gh issue edit "$NUMBER" --add-label "$LABELS"
           env:
             GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
             GH_REPO: ${{ github.repository }}
             NUMBER: ${{ github.event.issue.number }}
             LABELS: triage
   

4. Personnalisez les valeurs env dans votre fichier de workflow :

   • Les valeurs GH_TOKEN, GH_REPO et NUMBER sont automatiquement définies à l’aide des contextes github et secrets. Il est inutile de les modifier.
   • Remplacez la valeur de LABELS par la liste des étiquettes que vous souhaitez ajouter au problème. Les étiquettes doivent exister pour votre référentiel. Séparez plusieurs étiquettes par des virgules. Par exemple : help wanted,good first issue. Pour plus d’informations sur les étiquettes, consultez « Gestion des étiquettes ».

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 ouvert ou rouvert, ce workflow ajoute les étiquettes que vous avez spécifiées au problème.

Testez votre workflow en créant un problème dans votre dépôt.

1. Créez un problème dans votre dépôt. Pour plus d’informations, consultez « Création d’un problème ».
2. Pour voir l’exécution du workflow qui a été déclenchée par la création 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 ».
3. Une fois le workflow terminé, les étiquettes spécifiées doivent avoir été ajoutées au problème que vous avez créé.

Étapes suivantes

• Pour en savoir plus sur les tâches supplémentaires que vous pouvez effectuer avec la GitHub CLI, consultez le manuel de GitHub CLI.
• Pour en savoir plus sur les différents événements qui peuvent déclencher votre workflow, consultez « Événements qui déclenchent des flux de travail ».
• Recherchez sur GitHub des exemples de workflow utilisant gh issue edit.