Utilisation d’artifacts présentant des problèmes

Conservez des plans, des recherches, des liens et du code HTML interactif en même temps que le ticket auquel ils se rapportent.

Qui peut utiliser cette fonctionnalité ?

Issue artifacts are available on GitHub.com and GitHub Enterprise Cloud.

Dans cet article

Cette fonctionnalité est en préversion publique et peut être modifiée.

Les artefacts associés à un ticket sont des éléments de contenu nommés attachés à un ticket. Ils fournissent un espace pérenne pour conserver des plans, des recherches, des décisions, des prototypes et des documents de référence comme contexte à côté de votre travail.

Vous pouvez partager des artefacts avec d’autres personnes via une URL et, si vous mettez à jour un artefact, GitHub conservera un enregistrement des modifications afin de pouvoir revenir en arrière et voir comment un artefact a évolué au cours d’un projet.

Types d’artefacts pris en charge

Les artefacts d’incident prennent en charge les types suivants :

  • Document Markdown (generic)  : contenu à usage général, tel que la recherche, les notes d’investigation ou un document de conception.
  • Plan (plan)  : plan d’implémentation Markdown.
  • Lien (link)  : lien nommé vers du contenu ailleurs, tel qu’une discussion, un prototype ou un thread Slack ou Teams.
  • Fichier HTML (embedded_html)  : document HTML autonome, tel qu’un prototype interactif, une visualisation, un organigramme ou un diagramme.

Création d’un artefact

Vous pouvez créer des artefacts sur GitHub.com, ou demander à un agent ou à un outil développeur d’en créer un à l’aide du serveur MCP intégré GitHub, GitHub CLI ou de l’API REST des artefacts d’issue. Par exemple, vous pouvez demander à Copilot app de créer un plan d’implémentation, une analyse de la cause racine ou un résumé de recherche et l’attacher au problème.

Création d’un artefact sur GitHub.com

  1. Accédez au ticket où vous souhaitez créer un artefact.
  2. Dans la section Artefacts , cliquez sur .
  3. Sélectionnez un type d’artefact :
    • Pour ajouter une URL nommée, cliquez sur Ajouter un lien.
    • Pour créer un document Markdown, cliquez sur Créer un artefact.
    • Pour créer un document HTML, cliquez sur Créer un artefact HTML.
  4. Suivez les invites pour nommer et créer l’artefact.

Affichage et partage d’un artefact

  1. Accédez au ticket contenant l’artefact.
  2. Dans la section Artefacts , cliquez sur le nom de l’artefact.
  3. L’artefact s’ouvre et s’affiche dans un panneau latéral sur le ticket.
  4. Pour copier l’URL pour partager l’artefact avec d’autres utilisateurs, cliquez sur .

Modifier un artefact

  1. Ouvrez l’artefact.
  2. Dans le volet d’artefacts, cliquez sur .
  3. Mettez à jour le nom ou le contenu de l’artefact.
  4. Enregistrez vos modifications.

La modification d’un artefact crée une version dans son historique.

Affichage de l’historique des versions d’un artefact

  1. Ouvrez l’artefact.
  2. Dans le volet d’artefacts, cliquez sur .
  3. Sélectionnez une version pour afficher son nom, son contenu, son auteur et son heure de création.

Vous ne pouvez pas restaurer une version dans l’interface web. Pour restaurer une version antérieure, utilisez gh issue artifact edit --restore-version. La restauration enregistre le nom et le contenu précédents en tant que nouvelle version, en conservant l’historique complet.

Réorganisation des artefacts

Vous pouvez réorganiser les artefacts en les faisant glisser dans la section Artefacts . Vous pouvez également cliquer sur à côté d’un artefact, cliquer sur Déplacer, puis choisir une position.

Suppression d’un artefact

Avertissement

La suppression d’un artefact est permanente et supprime également son historique des versions.

  1. Dans la section Artefacts du ticket, cliquez sur à côté de l’artefact.
  2. Cliquez sur Supprimer.

Aperçu sécurisé d’un artefact HTML

Sur GitHub.com, les artefacts HTML s’ouvrent en mode Source, ce qui vous permet d’inspecter le code avant de l’exécuter. Pour afficher le rendu HTML, sélectionnez Aperçu. GitHub affiche l’aperçu dans une sandbox restreinte. L’interface avertit que l’aperçu exécute du code fourni par l’utilisateur qui peut envoyer son contenu à des sites externes. Passez en revue la source et affichez uniquement un aperçu html à partir de sources auxquelles vous faites confiance. Pour revenir à la source, sélectionnez Source.

Utilisation d’artefacts avec des agents

Lorsque vous utilisez Copilot app pour travailler sur un problème, les artefacts créés pendant la session sont automatiquement attachés au problème. Vous pouvez également demander à Copilot de créer un artefact spécifique, tel qu’un plan d’implémentation, une analyse de la cause racine ou un résumé du contexte historique.

Les agents et les outils de développement peuvent également utiliser le serveur MCP intégré GitHub , l’API REST ou GitHub CLI pour lire et gérer des artefacts.

Gestion des artefacts avec GitHub CLI

Les commandes d’artefact Issue nécessitent GitHub CLI la version 2.103.0 ou ultérieure.

Pour plus d’informations sur les commandes des artefacts de ticket, consultez la gh issue artifact référence.

Pour en savoir plus