Artefatos do GitHub Issues dão um lugar estável aos planos

Dev
Visualizações 2

O código está no pull request, mas sua justificativa pode ficar perdida em uma conversa antiga. Se a investigação de um agente estiver em outro lugar, a próxima pessoa talvez a repita. Em 28 de outubro, o GitHub apresentou a prévia pública de artefatos anexados diretamente às issues.

Conversa e documento têm funções diferentes

Artefatos podem ser documentos Markdown, links externos e HTML: análises de causa, protótipos ou discussões no Slack e Teams. No github.com, podem ser criados e editados mantendo versões. São diferentes dos artefatos do GitHub Actions, que resultam de execuções de workflows.

Imagine um pagamento processado duas vezes, num exemplo fictício. Comentários registram observações novas; o plano descreve a chave das tentativas e os experimentos pendentes. A primeira imagem foi criada para este artigo, não é uma tela do GitHub. Separar observações de hipóteses evita tratar uma suspeita como requisito.

Exemplo original e fictício de retry-plan.md, com observações, hipóteses e experimentos; não é uma tela do GitHub.
Exemplo original e fictício de retry-plan.md, com observações, hipóteses e experimentos; não é uma tela do GitHub.

Anexe um arquivo e mantenha o mesmo contexto

gh issue artifact create recebe o número ou URL da issue e arquivos ou links. gh issue artifact create 42 retry-plan.md -R OWNER/REPO anexaria o arquivo à issue 42. Os valores são exemplos; executar cria conteúdo na issue. Não executamos esse comando para o artigo.

O nome pode vir do arquivo ou de --name. --body-file lê o conteúdo de um documento, e --attach permite imagens e vídeos. gh issue artifact edit 42 1 --body-file retry-plan.md -R OWNER/REPO substitui o conteúdo. A segunda imagem ilustra sintaxe, não um envio concluído.

Exemplos de sintaxe oficial; OWNER/REPO, 42 e 1 são valores a substituir, sem execução.
Exemplos de sintaxe oficial; OWNER/REPO, 42 e 1 são valores a substituir, sem execução.

O plano atual pode preservar sua trajetória

edit altera nome ou conteúdo, mas não o tipo. --restore-version salva nome e conteúdo antigos como nova versão; view exibe o histórico. Assim, atualizar o plano não exige apagar sua evolução.

No exemplo, a suspeita poderia passar de timeout para tratamento de chaves duplicadas. Atualizar o plano e vincular um comentário com a explicação é uma sugestão de organização, não um automatismo garantido. O documento também não substitui evidências sobre o código.

O suporte a HTML depende da interface

O anúncio descreve alternar entre prévia HTML e fonte. Criar e visualizar HTML no GitHub App, porém, aparece como recurso futuro. Anexar automaticamente resultados de uma sessão não significa suporte completo em todas as interfaces. A CLI também permanece em prévia.

O benefício está em encontrar o contexto perto da tarefa, não em produzir mais documentos. Um plano existente e sua próxima revisão bastam para explorar o fluxo. As fontes oficiais explicam os limites atuais.

Fontes e leituras

GitHub Changelog · 2026-10-28

GitHub CLI · issue artifact

GitHub CLI · create

GitHub CLI · edit