Configuration de liens automatiques pour référencer des ressources externes

Vous pouvez ajouter des liens automatiques à des ressources externes comme des problèmes JIRA et des tickets Zendesk pour simplifier votre workflow.

Qui peut utiliser cette fonctionnalité ?

Les liens automatiques sont disponibles dans les référentiels avec GitHub Pro, GitHub Team, GitHub Enterprise Cloud, et GitHub Enterprise Server.

Dans cet article

Toute personne disposant d’autorisations d’administrateur pour un dépôt peut configurer des références de lien automatique pour lier des problèmes, des demandes de tirage, des messages de commit et des descriptions de mise en production à des services tiers externes.

Les références de lien automatique acceptent désormais les caractères alphanumériques. Quand ils ont été introduits initialement, les liens automatiques personnalisés étaient limités aux ressources externes utilisant des identificateurs numériques. Les liens automatiques personnalisés fonctionnent désormais avec des identificateurs alphanumériques et numériques.

Vous définissez les liens automatiques personnalisés en spécifiant un préfixe de référence et une URL cible.

  • Les préfixes de référence ne peuvent pas présenter des noms qui se chevauchent. Un référentiel ne peut par exemple pas avoir deux liens automatiques personnalisés avec des préfixes comme TICKET et TICK, étant donné que les deux préfixes correspondent à la chaîne TICKET123a.
  • Les URL cibles incluent une variable <num> qui représente l’identificateur de référence de la ressource liée.

Cette procédure montre comment configurer les liens automatiques pour référencer des ressources externes. Si vous utilisez Zendesk par exemple pour suivre les tickets signalés par l’utilisateur, vous pouvez référencer un numéro de ticket dans la demande de tirage (pull request) que vous avez ouverte pour résoudre le problème.

  1. Sur GitHub, accédez à la page principale du référentiel.

  2. Sous le nom de votre dépôt, cliquez sur Paramètres. Si vous ne voyez pas l’onglet « Paramètres », sélectionnez le menu déroulant , puis cliquez sur Paramètres.

    Capture d’écran d’un en-tête de dépôt montrant les onglets. L’onglet « Paramètres » est mis en évidence avec un encadré orange foncé.

  3. Dans la section « Intégrations » de la barre latérale, cliquez sur Références de lien automatique.

  4. En haut à droite de la page, cliquez sur Ajouter une référence de lien automatique.

    Capture d’écran de la page « Références de lien automatique ». Le bouton « Ajouter une référence de lien automatique » est mis en évidence avec un encadré orange foncé.

  5. Sélectionnez le format de l’identificateur de référence utilisé dans la ressource externe, alphanumérique ou numérique.

  6. Sous « Préfixe de référence », tapez un préfixe court et explicite. Les collaborateurs utilisent ce texte pour générer des liens automatiques pour la ressource externe.

  7. Sous « URL cible », tapez le format du lien vers le système externe que vous souhaitez créer. Utilisez la variable <num> comme espace réservé pour l’identificateur de référence.

  8. Examinez l’aperçu et vérifiez que le lien automatique et la référence externe sont corrects, puis cliquez sur Ajouter une référence de lien automatique pour définir le lien.

Par exemple, vous pourriez entrer ce qui suit.

  • Préfixe de référence : JIRA-
  • URL cible : https://jira.example.com/issue?query=<num>
  • Aperçu : JIRA-123 est converti en https://jira.example.com/issue?query=123