問題のあるアーティファクトの使用

計画、調査、リンク、対話型 HTML を、それらが関連する課題と共に保持します。

この機能を使用できるユーザーについて

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

この記事で

この機能はパブリック プレビュープレビューで、変更される可能性があります。

Issue アーティファクトは、問題にアタッチされた名前付きコンテンツです。 計画、調査、決定、プロトタイプ、参考資料を、作業と共にコンテキストとして保持するための長く使える場所を提供します。

成果物は URL を介して他のユーザーと共有できます。成果物を更新すると、変更の記録は GitHub によって保持されるため、プロジェクトの過程で成果物がどのように進化したかを確認できます。

サポートされている成果物の種類

Issue アーティファクトでは、次の種類がサポートされます。

  • Markdown ドキュメント (generic): 研究、調査ノート、デザイン ドキュメントなどの汎用コンテンツ。
  • プラン (plan): Markdown 実装計画。
  • リンク (link): ディスカッション、プロトタイプ、Slack、Teams スレッドなど、他の場所にあるコンテンツへの名前の付いたリンク。
  • HTML ファイル (embedded_html): 対話型プロトタイプ、視覚化、フローチャート、図などの自己完結型 HTML ドキュメント。

成果物の作成

GitHub.comでアーティファクトを作成するか、組み込みの GitHub MCP サーバー、GitHub CLI、または issue artifacts REST API を使用してアーティファクトを作成するようにエージェントまたは開発者ツールに依頼できます。 たとえば、 Copilot app に実装計画、根本原因分析、調査の概要を作成して問題に添付するように依頼できます。

GitHub.com で成果物を作成する

  1. 成果物を作成する課題に移動します。
  2. [成果物] セクションで、[] をクリックします。
  3. 成果物の種類を選択してください:
    • 名前付き URL を追加するには、[ リンクの追加] をクリックします。
    • Markdown ドキュメントを作成するには、[ アーティファクトを作成] をクリックします。
    • HTML ドキュメントを作成するには、[HTML アーティファクトを作成] をクリックします。
  4. 画面の指示に従って、アーティファクトに名前を付けて作成してください。

成果物の表示と共有

  1. 成果物を含む課題に移動します。
  2. [成果物] セクションで、成果物の名前をクリックします。
  3. 成果物が開き、課題上のサイド パネルに表示されます。
  4. 成果物を他のユーザーと共有する URL をコピーするには、[ ] をクリックします。

アーティファクトの編集

  1. アーティファクトを開く。
  2. アーティファクト パネルで、 をクリックします。
  3. 成果物の名前または内容を更新してください。
  4. 変更を保存。

アーティファクトを編集すると、履歴にバージョンが作成されます。

成果物のバージョン履歴の表示

  1. アーティファクトを開く
  2. アーティファクト パネルで、 をクリックします。
  3. バージョンを選択すると、その名前、コンテンツ、作成者、作成時刻が表示されます。

Web インターフェイスでバージョンを復元することはできません。 以前のバージョンを復元するには、 gh issue artifact edit --restore-versionを使用します。 復元すると、以前の名前とコンテンツが新しいバージョンとして保存され、完全な履歴が保持されます。

アーティファクトの並べ替え

成果物は、成果物 セクション内でドラッグして並べ替えることができます。 成果物の横にある [ ] をクリックし、[ 移動] をクリックして、位置を選択することもできます。

成果物を削除する

警告

成果物は完全に削除され、そのバージョン履歴も削除されます。

  1. 問題の [ 成果物 ] セクションで、成果物の横にある [ ] をクリックします。
  2. [削除] をクリックします。

HTML 成果物を安全にプレビューする

GitHub.comでは、HTML アーティファクトがソース ビューで開くので、コードを実行する前に確認できます。 HTML をレンダリングするには、プレビュー を選択します。 GitHub は、制限付きサンドボックスにプレビューをレンダリングします。 このインターフェイスは、プレビューによって、外部サイトにその内容を送信する可能性があるユーザー指定のコードが実行されることを警告します。 ソースを確認し、信頼できるソースの HTML のみをプレビューしてください。 ソースに戻すには、ソース を選択します。

エージェントでのアーティファクトの使用

Copilot appを使用して問題に取り組むと、セッション中に作成された成果物が自動的に問題にアタッチされます。 実装計画、根本原因分析、履歴コンテキストの概要など、特定の成果物を作成するように Copilot に依頼することもできます。

エージェントと開発者ツールは、組み込みの GitHub MCP サーバー、REST API、または GitHub CLI を使用して成果物の読み取りと管理を行うこともできます。

GitHub CLI を使用したアーティファクトの管理

Issue artifact コマンドには、GitHub CLI 2.103.0 以降が必要です。

issue artifact コマンドの詳細については、gh issue artifactリファレンスを参照してください。

詳細については、次を参照してください。