Partager via


Lier les commits, pull requests, branches et issues GitHub aux éléments de travail dans Azure Boards

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

Dans cet article, découvrez comment lier des éléments de travail à des validations GitHub, des demandes d’extraction, des branches et des builds après avoir connecté votre projet Azure Boards à un référentiel GitHub. Vous pouvez utiliser la syntaxe #mention pour les commits et les branches, utiliser la syntaxe des ! mentions pour référencer les demandes d'extraction GitHub à partir des discussions sur les éléments de travail, ou ajouter directement un commit, une demande d'extraction ou un lien de branche GitHub dans l'élément de travail Azure Boards.

Remarque

Support d’intégration pour GitHub :

  • Azure DevOps Services : s’intègre aux référentiels GitHub.com et GitHub Enterprise Server via l’application Azure Boards pour GitHub.
  • Azure DevOps Server 2020 et versions ultérieures : prend en charge l’intégration aux référentiels GitHub Enterprise Server uniquement.
  • Autres référentiels Git : l’intégration n’est pas prise en charge.

Prérequis

Catégorie Exigences
Permissions Contributor au projet Azure Boards et au référentiel GitHub.
Connexion de projet Le projet Azure Boards est connecté au référentiel GitHub où existent les validations, les pull requests et la branche avec lesquelles vous souhaitez établir un lien. Pour plus d’informations, consultez Azure Boards-GitHub integration.

Remarque

Pour afficher la section Développement et les types de liens GitHub, les projets utilisant le modèle de processus XML hébergé nécessitent une mise à jour des types d’éléments de travail. Pour plus d’informations, consultez Mettre à jour les définitions XML pour sélectionner les types d’éléments de travail.

À partir d’un commit GitHub, d’une pull request ou d’un problème, utilisez la syntaxe suivante pour créer un lien vers votre ticket Azure Boards. Entrez le dans le texte d’un message de validation. Ou, pour un pull request ou un ticket, entrez la dans la description. L'utilisation de dans un titre de commentaire ou de pull request ne crée pas de lien sur l'élément de travail.

AB#{ID}

Par exemple, établit un lien à l’ID d’élément de travail 125.

Vous pouvez également entrer un message de validation ou de pull request pour faire avancer l’élément de travail. Le système reconnaît ou , ainsi que , , et , et l’applique à l’élément #-mention qui suit.

Lorsqu’une description de demande de tirage inclut un nom d’état valide, par exemple, , le système met à jour en conséquence l’élément de travail référencé. Si le nom d'état n'est pas reconnu directement, Azure Boards tente de le faire correspondre à une catégorie de flux de travail telle que Resolved ou Completed. Si une correspondance est trouvée, l’élément de travail passe au premier état disponible défini dans cette catégorie.

Par défaut, les éléments de travail référencés avec , ou transition vers le premier état associé à la catégorie résolue . Si aucun état de ce type n’existe dans le processus actuel, le système passe plutôt l’élément de travail à la première état de la catégorie Terminé .

Importante

Vous pouvez toujours lier des éléments de travail et cibler d’autres branches, mais les règles de transition d’état ne s’appliquent que si le pull request est fusionné dans la branche par défaut.

Pour plus d’informations, consultez Comment les états des catégories de flux de travail sont utilisés dans les arriérés et tableaux Azure Boards.

Examinez le tableau suivant pour obtenir des exemples :

Message de validation ou de demande de tirage Action
Fixed AB#123 Lie et transfère l’élément de travail vers la catégorie d’état du flux de travail Résolu ou, si aucune n’est définie, vers la catégorie d’état du flux de travail Terminée.
Closed AB#123 Lie et transfère l’élément de travail à l’état du flux de travail fermé . Si aucune n’est définie, aucune transition n’est effectuée.
Adds a new feature, fixes AB#123. Lie et transfère l’élément de travail vers la catégorie d’état du flux de travail Résolu ou, si aucune n’est définie, vers la catégorie d’état du flux de travail Terminée.
Fixes AB#123, AB#124, and AB#126 Liens vers les éléments de travail d'Azure Boards 123, 124 et 126. Passe uniquement le premier élément, 123 à la catégorie d’état de flux de travail résolu ou, si aucun n’est défini, la catégorie d’état de flux de travail terminée .
Fixes AB#123, Fixes AB#124, Fixes AB#125 Liens vers les éléments de travail Azure Boards 123, 124 et 126. Effectue la transition de tous les éléments vers la catégorie d’état du flux de travail résolu ou, si aucun n’est défini, la catégorie d’état du flux de travail terminé.
Fixing multiple bugs: issue #123 and user story AB#234 Liens vers GitHub problème 123 et Azure Boards élément de travail 234. Aucune transition n’est effectuée.

Remarque

Si vous avez connecté le même répertoire GitHub à des projets définis dans deux organisations Azure DevOps ou plus, vous pourriez constater des mentions AB# se lier de manière inattendue. Pour plus d’informations, consultez Résoudre les problèmes de connexion. Pour cette raison, nous vous recommandons de connecter uniquement un dépôt GitHub aux projets définis dans une seule organisation Azure DevOps.

Lorsque vous ajoutez un lien à un élément de travail à l’aide de AB# dans une description de demande de tirage, ces liens apparaissent dans la section Development de la demande de tirage GitHub. Ces liens sont disponibles uniquement lorsque vous utilisez dans la description du pull request. Elles n’apparaissent pas si vous créez un lien direct vers le pull request depuis l’élément de travail. La suppression de la référence de la description le supprime également de la section Développement.

Capture d'écran des liens AB# dans la section développement d'une demande de tirage sur GitHub.

Créer une branche GitHub depuis l’élément de travail

Pour créer une branche GitHub directement à partir d’un élément de travail, procédez comme suit :

  1. À partir de votre tableau, recherchez l’élément de travail que vous souhaitez utiliser pour créer une branche GitHub.

  2. Sélectionnez Actions d'élément de travail>Nouvelle branche GitHub.

    Capture d'écran de l'élément de travail, sélection de Plus d'actions et mise en surbrillance de l'option Nouvelle branche GitHub.

  3. Dans la boîte de dialogue Créer une branche GitHub, entrez le nom de la branche. Sélectionnez le référentiel GitHub et la branche de base.

  4. Sélectionnez Créer.

    Capture d'écran de la boîte de dialogue Créer une branche GitHub.

    Azure Boards crée la branche dans le référentiel GitHub spécifié et la lie à l’élément de travail. Pour plus d’informations, consultez Azure Boards-GitHub integration.

  1. Ouvrez votre élément de travail et accédez à la zone Développement .

  2. Sélectionnez Ajouter un lien. Dans chaque menu déroulant, sélectionnez votre type de lien, référentiel GitHub et pull request GitHub. Vous pouvez rechercher et explorer le référentiel pour trouver et sélectionner une pull request ou un commit spécifique, sans avoir à copier et coller une URL.

  3. Sélectionnez Ajouter un lien.

    Capture d’écran montrant une séquence en cinq étapes pour ajouter un lien de pull request à l’élément de travail.

    Azure Boards vérifie que vous avez entré un lien valide. Le référentiel lié à GitHub doit être connecté au projet Azure Boards ou la validation échoue.

Remarque

Si vous utilisez Azure DevOps Server et GitHub Enterprise Server, il y a un délai lors de la complétion des liens AB#. Le processus utilise une conception « push-and-pull » pour extraire les événements de GitHub toutes les heures, en se concentrant sur les modifications incrémentielles des commits, des pull requests (PR) et des issues.

Plusieurs événements mettent automatiquement à jour les liens sur le formulaire d’élément de travail. Vous n’avez donc pas besoin de les créer manuellement. Ces événements sont les suivants :

événement GitHub Action
Lien vers la branche Lorsqu'un pull request est créé à partir d'une branche, il est automatiquement lié à l'élément de travail.
Commit de fusion Après que le pull request est fusionné, le commit de fusion résultant est automatiquement lié à l'élément de travail.
Supprimer une branche Si la branche est supprimée (généralement après la fusion), son lien est automatiquement supprimé de l’élément de travail.

La section Développement du formulaire d’élément de travail répertorie les liens créés pour les commits et pull requests GitHub à l’aide de l’icône GitHub.

Capture d'écran du formulaire d'élément de travail, la section Développement affiche des liens GitHub.

Sélectionnez le lien pour ouvrir le commit ou la pull request dans GitHub.

Aperçus des Pull Requests GitHub

Les demandes de tirage GitHub liées dans la section Développement affichent des détails de statut supplémentaires, vous permettant ainsi d’évaluer la progression sans ouvrir la demande dans GitHub.

Conditions préalables pour les aperçus des requêtes de tirage

Pour afficher les insights des pull requests, accédez à l'application Azure Boards dans GitHub et acceptez les autorisations mises à jour pour l'accès en lecture et en écriture aux Checks.

Screenshot de la boîte de dialogue autorisations de l’application Azure Boards GitHub affichant les autorisations de vérification mises à jour.

Afficher les détails de l’état du pull request

  1. Ouvrez un élément de travail qui a une pull request GitHub liée.

  2. Dans la section Développement, recherchez le pull request lié. Les détails d’état suivants s’affichent à côté du lien de la pull request :

    • État brouillon : indique si le pull request est toujours un brouillon.
    • État de la révision : indique si la requête de tirage a besoin d’une révision, a été approuvée ou si des modifications ont été demandées.
    • État des vérifications : indique si les vérifications CI passent, échouent ou sont en attente.

    Capture d'écran de la section Développement montrant une pull request GitHub liée avec des indicateurs de statut fermé, en revue et vérifié.

  3. Pointez sur un indicateur d’état pour afficher plus de détails ou sélectionnez le lien de pull request pour l’ouvrir directement dans GitHub.

Mentionnez les pull requests GitHub à l’aide de !

Utilisez ! mentions pour référencer et discuter des pull requests GitHub directement depuis un champ de texte enrichi ou un commentaire de discussion d’un élément de travail. Lorsque vous tapez ! dans un champ de texte, un sélecteur s’affiche pour rechercher et sélectionner une demande de tirage GitHub à partir d’un référentiel connecté. La pull request sélectionnée est insérée sous forme de lien cliquable.

Il est facile de faire référence aux pull requests associés dans les descriptions des éléments de travail, les critères d'acceptation ou les discussions sans copier manuellement les URL.

GIF montrant comment utiliser la commande !mention pour faire référence à une pull request GitHub dans la discussion d'un élément de travail.

Afficher l’état de build pour les pipelines YAML (intégré dans la build)

Lorsque vous utilisez Azure Pipelines YAML pour générer du code hébergé dans un référentiel GitHub, vous pouvez automatiquement créer des liens intégrés dans la build sur les éléments de travail associés. Cette fonctionnalité assure la traçabilité des builds pour les dépôts GitHub, atteignant ainsi la parité avec l'expérience disponible pour Azure Repos.

Pour activer cette fonctionnalité :

  1. Ouvrez votre pipeline YAML, sélectionnez Autres actions, puis sélectionnez Paramètres.

  2. Dans la boîte de dialogue Paramètres du pipeline , activez la liaison automatique des nouveaux éléments de travail dans cette build.

    Capture d’écran de la boîte de dialogue Paramètres du pipeline YAML montrant le lien automatique des nouveaux éléments de travail dans cette option de génération.

Une fois la génération terminée, un lien Intégré dans la génération apparaît automatiquement dans la section Développement de chaque élément de travail associé, offrant à votre équipe une traçabilité complète de l’élément de travail à la génération.

Capture d’écran de l’élément de travail montrant le lien Intégré dans la build dans la section Développement.

Pour plus d’informations sur la configuration de ce paramètre, consultez Configurer des pipelines pour prendre en charge le suivi des travaux.

Afficher GitHub objets sur une carte

En activant les annotations GitHub sur le tableau, vous pouvez rapidement ouvrir des commits GitHub liés, des requêtes de tirage ou des tickets pour obtenir plus de détails. Pour plus d’informations, consultez Personnaliser les cartes.

Capture d'écran du tableau qui affiche des liens GitHub sur les cartes d'éléments de travail.

Étapes suivantes

Configurer des badges d’état