Использование артефактов с проблемами

Следите за планами, исследованиями, ссылками и интерактивным HTML-кодом вместе с проблемой, которой они поддерживают.

Кто может использовать эту функцию?

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

В этой статье

Эта функция включена Публичный предварительный просмотр и подлежит изменению.

Артефакты проблемы называются фрагментами содержимого, присоединенного к проблеме. Они обеспечивают устойчивое место для поддержания планов, исследований, решений, прототипов и справочных материалов в качестве контекста вместе с вашей работой.

Вы можете поделиться артефактами с другими пользователями с помощью URL-адреса, а если обновить артефакт, сохраните запись изменений, GitHub чтобы вернуться и увидеть, как артефакт развивался в течение проекта.

Поддерживаемые типы артефактов

Артефакты проблемы поддерживают следующие типы:

  • Документ Markdown (generic): содержимое общего назначения, например исследования, заметки о расследовании или проектный документ.
  • План (plan): план реализации Markdown.
  • Ссылка (link): именованная ссылка на содержимое в другом месте, например обсуждение, прототип или поток Slack или Teams.
  • HTML-файл (embedded_html): автономный HTML-документ, например интерактивный прототип, визуализация, блок-схема или схема.

Создание артефакта

Вы можете создавать артефакты или запрашивать агент или средство разработчика для создания артефактов GitHub.comс помощью встроенного GitHub сервера GitHub CLIMCP или 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. Выберите версию для просмотра его имени, содержимого, автора и времени создания.

Невозможно восстановить версию в веб-интерфейсе. Чтобы восстановить более раннюю версию, используйте 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

Для команд артефактов проблемы требуется GitHub CLI 2.103.0 или более поздней версии.

Дополнительные сведения о командах артефактов проблемы см. в справочникеgh issue artifact.

Дополнительные материалы