Ajouter des badges d’état pour votre dépôt GitHub

Azure DevOps Services | Azure DevOps Server 2022 | Azure DevOps Server 2019

Vous pouvez ajouter la syntaxe Markdown au fichier README.md d’un référentiel GitHub pour afficher l’état de votre tableau Kanban dans ce référentiel. Affichez l’état en ajoutant la syntaxe que vous choisissez dans vos paramètres de tableau Kanban.

Notes

Nécessite Azure DevOps Server 2019 Update 1 ou version ultérieure.

La syntaxe indiquée fonctionne si vous avez connecté votre projet à GitHub.com ou à votre référentiel GitHub Enterprise Server. Pour GitHub Enterprise Server, votre serveur doit être accessible au réseau pour Azure DevOps Services.

Prérequis

  • Votre projet Azure Boards doit être connecté au dépôt GitHub où existent les validations et les demandes de tirage vers lesquelles vous souhaitez créer un lien. Pour plus d’informations, consultez Intégration Azure Boards-GitHub.
  • Vous devez disposer d’un tableau Kanban que vous souhaitez configurer. Lorsque vous ajoutez une équipe, vous ajoutez un tableau Kanban pour cette équipe. Pour plus d’informations, consultez À propos des équipes et des outils Agile.
  • Vous devez être ajouté au rôle d’administrateur d’équipe pour les paramètres de l’équipe que vous souhaitez modifier, ou être membre du groupe de sécurité Administrateurs de projet. Pour être ajouté, consultez Ajouter un administrateur d’équipe ou Modifier les autorisations au niveau du projet.
  • Pour ajouter le badge d’état au dépôt GitHub.com, vous devez être contributeur du dépôt.

Ajouter un badge d’état

  1. Connectez-vous à Azure Boards et ouvrez le tableau Kanban.

  2. Choisissez l’icône d’engrenage pour configurer le tableau et définir les paramètres généraux de l’équipe.

    Screenshot of opening board settings.

  3. Choisissez Badge d’état, puis cochez ou décochez la case Autoriser les utilisateurs anonymes à accéder au badge d’état. Lorsqu’ils ne sont pas activés, les utilisateurs qui ne sont pas connectés peuvent toujours afficher le badge d’état.

    Screenshot of Kanban Board Settings dialog, Status badge tab.

    Screenshot of Kanban Board Settings dialog, Status badge tab, Azure DevOps Server 2019.

  4. Choisissez le type de badge souhaité et choisissez l’icône de copie pour copier la syntaxe Markdown du badge.

    • Afficher les colonnes « En cours » uniquement ignore les première et dernière colonnes.
    • Inclure toutes les colonnes inclut les première et dernière colonnes du tableau.
    • Vous pouvez également personnaliser l’ensemble de colonnes en spécifiant 2 pour la colonne Options, puis une liste délimitée par des virgules pour les colonnes du tableau à afficher. Par exemple, ?columnOptions=2&columns=Proposed,Committed,In%20Progress,In%20Review, comme indiqué dans la syntaxe suivante. Pour les étiquettes de colonne qui incluent des espaces, vous devez encoder l’espace avec %20. Par exemple : In%20Progress.
     [![Board Status](https://dev.azure.com/fabrikam/677da0fb-b067-4f77-b89b-f32c12bb8617/cdf5e823-1179-4503-9fb1-a45e2c1bc6d4/_apis/work/boardbadge/6fa7b56f-d27c-4e96-957d-f9e7b0f56705?columnOptions=2&columns=Proposed,Committed,In%20Progress,In%20Review)](https://dev.azure.com/fabrikam/677da0fb-b067-4f77-b89b-f32c12bb8617/_boards/board/t/cdf5e823-1179-4503-9fb1-a45e2c1bc6d4/Microsoft.RequirementCategory/)
    

    Un badge similaire au suivant s’affiche.

    Screenshot showing badge rendered.

  5. Quand vous avez terminé, sélectionnez Enregistrer.

    Le seul paramètre que vous pouvez configurer est Autoriser les utilisateurs anonymes à accéder au badge d’état. Le type de badge sous Paramètres change uniquement la syntaxe Markdown que vous pouvez copier à partir des valeurs Markdown et URL de l’image.

  6. Ouvrez le fichier Lisez-moi dans votre référentiel GitHub et collez la syntaxe que vous avez copiée pour afficher le badge.

    Vous devriez voir la même image d’aperçu que celle que vous avez sélectionnée avec des valeurs qui correspondent à votre tableau Kanban.