Verwenden von Artefakten mit Problemen

Halten Sie Pläne, Recherchen, Links und interaktiven HTML-Code zusammen mit dem Issue, das sie unterstützen.

Wer kann dieses Feature verwenden?

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

In diesem Artikel

Dieses Feature befindet sich in Öffentliche Vorschau und kann sich ändern.

Issue-Artefakte sind Inhaltelemente mit Namen, die an ein Issue angefügt sind. Sie bieten einen dauerhaften Ort, um Pläne, Forschung, Entscheidungen, Prototypen und Referenzmaterial als Kontext neben Ihrer Arbeit aufzubewahren.

Sie können Artefakte über eine URL für andere freigeben, und wenn Sie ein Artefakt aktualisieren, zeichnet GitHub die Änderungen auf, sodass Sie zurückgehen und sehen können, wie sich ein Artefakt im Laufe eines Projekts entwickelt hat.

Unterstützte Artefakttypen

Problemartefakte unterstützen die folgenden Typen:

  • Markdown-Dokument (generic): Allgemeiner Inhalt, z. B. Recherche, Untersuchungsnotizen oder Designdokument.
  • Plan (plan): Ein Markdown-Implementierungsplan.
  • Link (link): Ein benannter Link zu Inhalten an anderer Stelle, z. B. eine Diskussion, einen Prototyp oder einen Slack- oder Teams-Thread.
  • HTML-Datei (embedded_html): Ein eigenständiges HTML-Dokument, z. B. ein interaktiver Prototyp, eine Visualisierung, ein Flussdiagramm oder ein Diagramm.

Erstellen eines Artefakts

Sie können Artefakte erstellen GitHub.comoder einen Agent oder Entwicklertool bitten, ein Artefakt zu erstellen, GitHub CLIdas den integrierten MCP-Server GitHub oder die Issue-Artefakte-REST-API verwendet. Sie können z. B. den Copilot app auffordern, einen Implementierungsplan, eine Ursachenanalyse oder eine Forschungszusammenfassung zu erstellen und an das Problem anzufügen.

Erstellen eines Artefakts auf GitHub.com

  1. Navigieren Sie zu dem Issue, bei dem Sie ein Artefakt erstellen möchten.
  2. Klicken Sie im Abschnitt "Artefakte" auf .
  3. Wählen Sie einen Artefakttyp aus:
    • Klicken Sie auf "Link hinzufügen", um eine benannte URL hinzuzufügen.
    • Um ein Markdown-Dokument zu erstellen, klicken Sie auf Artefakt erstellen.
    • Zum Erstellen eines HTML-Dokuments klicken Sie auf HTML-Artefakt erstellen.
  4. Folgen Sie den Anweisungen, um das Artefakt zu benennen und zu erstellen.

Artefakt anzeigen und teilen

  1. Navigieren Sie zu dem Issue, das das Artefakt enthält.
  2. Klicken Sie im Abschnitt „Artefakte“ auf den Artefaktnamen.
  3. Das Artefakt wird in einem Seitenbereich des Issue geöffnet und angezeigt.
  4. Um die URL zu kopieren, um das Artefakt für andere personen freizugeben, klicken Sie auf .

Element bearbeiten

  1. Öffnen Sie das Artefakt.
  2. Klicken Sie im Artefaktbereich auf .
  3. Aktualisieren Sie den Artefaktnamen oder den Inhalt.
  4. Speichern Sie die Änderungen.

Durch das Bearbeiten eines Artefakts wird eine Version in seinem Verlauf erstellt.

Anzeigen des Versionsverlaufs eines Artefakts

  1. Öffnen Sie das Artefakt.
  2. Klicken Sie im Artefaktbereich auf .
  3. Wählen Sie eine Version aus, um den Namen, den Inhalt, den Autor und die Erstellungszeit anzuzeigen.

Sie können eine Version in der Weboberfläche nicht wiederherstellen. Um eine frühere Version wiederherzustellen, verwenden Sie gh issue artifact edit --restore-version. Beim Wiederherstellen wird der frühere Name und der Inhalt als neue Version gespeichert, wobei der vollständige Verlauf erhalten bleibt.

Neuordnung von Artefakten

Sie können Artefakte neu anordnen, indem Sie sie innerhalb des Abschnitts Artefakte ziehen. Sie können auch neben einem Artefakt klicken , auf "Verschieben" klicken und dann eine Position auswählen.

Löschen eines Artefakts

Warnung

Das Löschen eines Artefakts ist dauerhaft und löscht auch den Versionsverlauf.

  1. Klicken Sie im Abschnitt "Artefakte" des Issue neben dem Artefakt.
  2. Klicken Sie auf Löschen.

Sichere Vorschau eines HTML-Artefaktes

In GitHub.com werden HTML-Artefakte in der Quellansicht geöffnet, damit Sie den Code überprüfen können, bevor Sie ihn ausführen. Um das HTML zu rendern, wählen Sie Vorschau aus. GitHub rendert die Vorschau in einer eingeschränkten Sandbox. Die Schnittstelle warnt, dass die Vorschau vom Benutzer bereitgestellten Code ausführt, der den Inhalt möglicherweise an externe Websites sendet. Überprüfen Sie die Quelle, und zeigen Sie nur html-Code aus Quellen an, die Sie als vertrauenswürdig einstufen. Um zur Quelle zurückzukehren, wählen Sie Source aus.

Verwenden von Artefakten mit Agents

Wenn Sie mit Copilot app an einem Problem arbeiten, werden Artefakte, die während der Sitzung erstellt wurden, automatisch an das Problem angefügt. Sie können auch Copilot bitten, ein bestimmtes Artefakt zu erstellen, z. B. einen Implementierungsplan, eine Ursachenanalyse oder eine Zusammenfassung des historischen Kontexts.

Agents und Entwicklertools können auch den integrierten MCP-Server GitHub , die REST-API oder GitHub CLI zum Lesen und Verwalten von Artefakten verwenden.

Verwalten von Artefakten mit GitHub CLI

Befehle für Issue-Artefakte erfordern GitHub CLI 2.103.0 oder höher.

Weitere Informationen zu Befehlen für Issue-Artefakte finden Sie in der gh issue artifactReferenz.

Weiterführende Lektüre