Usando artefatos com problemas

Mantenha planos, pesquisas, links e HTML interativo junto com o item que eles dão suporte.

Quem pode usar esse recurso?

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

Neste artigo

Esse recurso está em prévia pública e está sujeito a alterações.

Artefatos de issue são itens de conteúdo nomeados anexados a um issue. Eles fornecem um lugar durável para manter planos, pesquisas, decisões, protótipos e material de referência como contexto ao lado de seu trabalho.

Você pode compartilhar artefatos com outras pessoas por meio de uma URL e, se atualizar um artefato, GitHub manterá um registro de alterações para que você possa voltar e ver como um artefato evoluiu ao longo de um projeto.

Tipos de artefato com suporte

Artefatos de item dão suporte aos seguintes tipos:

  • Documento markdown (generic): conteúdo de uso geral, como pesquisa, anotações de investigação ou um documento de design.
  • Plano (plan): um plano de implementação do Markdown.
  • Link (link): um link nomeado para conteúdo em outro lugar, como uma discussão, um protótipo ou um thread do Slack ou do Teams.
  • Arquivo HTML (embedded_html): um documento HTML autocontido, como um protótipo interativo, visualização, fluxograma ou diagrama.

Criando um artefato

Você pode criar artefatos em GitHub.com ou pedir a um agente ou a uma ferramenta de desenvolvedor que crie um usando o servidor MCP interno GitHub CLI, GitHub ou a API REST de artefatos de problema. Por exemplo, você pode pedir ao Copilot app que crie um plano de implementação, uma análise de causa raiz ou um resumo de pesquisa e o anexe ao problema.

Criando um artefato em GitHub.com

  1. Navegue até o item em que você deseja criar um artefato.
  2. Na seção Artefatos, clique em .
  3. Selecione um tipo de artefato:
    • Para adicionar uma URL nomeada, clique em Adicionar link.
    • Para criar um documento markdown, clique em Criar artefato.
    • Para criar um documento HTML, clique em Criar artefato HTML.
  4. Siga os prompts para nomear e criar o artefato.

Exibindo e compartilhando um artefato

  1. Navegue até o item que contém o artefato.
  2. Na seção Artefatos , clique no nome do artefato.
  3. O artefato será aberto e exibido em um painel lateral no issue.
  4. Para copiar a URL para compartilhar o artefato com outras pessoas, clique em .

Editando um artefato

  1. Abra o artefato.
  2. No painel de artefatos, clique em .
  3. Atualize o nome do artefato ou o conteúdo do artefato.
  4. Salve as alterações.

Ao editar um artefato, cria-se uma versão em seu histórico.

Exibindo o histórico de versão de um artefato

  1. Abra o artefato.
  2. No painel de artefatos, clique em .
  3. Selecione uma versão para exibir seu nome, conteúdo, autor e hora de criação.

Não é possível restaurar uma versão na interface da Web. Para restaurar uma versão anterior, use gh issue artifact edit --restore-version. Restaurar salva o nome e o conteúdo anteriores como uma nova versão, preservando o histórico completo.

Reordenação de artefatos

Você pode reordenar artefatos arrastando-os dentro da seção Artefatos . Você também pode clicar ao lado de um artefato, clicar em Mover e escolher uma posição.

Excluir um artefato

Aviso

A exclusão de um artefato é permanente e também exclui seu histórico de versões.

  1. Na seção Artefatos do item, clique ao lado do artefato.
  2. Clique em Excluir.

Visualizar com segurança um artefato HTML

Com GitHub.com ativado, artefatos HTML são abertos no modo de exibição Source para que você possa inspecionar o código antes de executá-lo. Para renderizar o HTML, selecione Visualização. GitHub renderiza a visualização em uma área restrita restrita. A interface avisa que a pré-visualização executa o código fornecido pelo usuário, que pode enviar seu conteúdo para sites externos. Examine a origem e apenas visualize o HTML das fontes em que você confia. Para retornar à source, selecione Source.

Usando artefatos com agentes

Quando você usa o Copilot app para trabalhar em um item, os artefatos criados durante a sessão são anexados automaticamente ao item. Você também pode solicitar Copilot a criação de um artefato específico, como um plano de implementação, análise de causa raiz ou resumo do contexto histórico.

Os agentes e as ferramentas de desenvolvedor também podem usar o servidor MCP interno GitHub, a API REST ou GitHub CLI para ler e gerenciar artefatos.

Gerenciando artefatos com GitHub CLI

Os comandos de issue artifact exigem GitHub CLI 2.103.0 ou posterior.

Para obter mais informações sobre comandos de artefato de issue, consulte a gh issue artifact referência.

Leitura adicional