Pular para o conteúdo
Integrações

GitHub

Conecte o GitHub App ao workspace para vincular pull requests às tarefas, ver o estado dos PRs e concluir tarefas quando o PR recebe merge.

A integração com o GitHub liga os pull requests às tarefas do Jiraya. Com ela, cada tarefa mostra os PRs que a resolvem, com o estado e as verificações de CI, e pode ser concluída sozinha quando o PR recebe merge.

A integração usa o GitHub App do Jiraya. Ela não é necessária para os agentes trabalharem em repositórios: eles usam as credenciais Git do próprio runtime para clonar, fazer commit, enviar branches e abrir PRs.

Conectar o GitHub

Só proprietários e administradores do workspace conectam ou desconectam o GitHub. Os outros membros veem a configuração em modo leitura.

Abra a integração

Vá em Configurações › Integrações e, em Código e repositórios, abra GitHub.

Instale o GitHub App

Clique em Conectar GitHub. O GitHub abre numa nova aba para você instalar o app na sua conta ou organização e escolher os repositórios que ele pode ver.

Para instalar numa organização, você precisa ser administrador dela no GitHub. Sem essa permissão, o GitHub registra só um pedido de instalação, que um administrador da organização precisa aprovar.

Autorize e volte ao Jiraya

Depois da instalação, o GitHub pede que você autorize o app e volta para as configurações do Jiraya. A seção Conexão passa a mostrar Conectado a com a conta ou organização instalada.

Uma mesma instalação do GitHub App pode atender a mais de um workspace. Os eventos dos PRs chegam a todos os workspaces conectados a ela.

Recursos

A chave Ativar recursos do GitHub liga e desliga a integração inteira no workspace. Desligada, ela pausa todos os recursos abaixo e mantém os dados já recebidos.

RecursoO que fazPadrão
Barra lateral de Pull RequestMostra os PRs vinculados no detalhe da tarefa.Ligado
Rodapé Co-authored-byAdiciona Co-authored-by: jiraya-agent <github@jiraya.io> aos commits que os agentes fazem nos repositórios do workspace.Ligado
Vincular tarefas e PRs automaticamenteVincula cada PR à tarefa citada nele (veja abaixo).Ligado
Concluir tarefa no mergeMove a tarefa para Concluído quando o PR que a fecha recebe merge. Exige o vínculo automático ligado.Desligado

Vincular um PR a uma tarefa

Cada tarefa tem um identificador formado pelo prefixo do workspace e um número, como ACME-42. O PR é vinculado à tarefa quando o identificador aparece:

  • no título do PR, como ACME-42: corrige o login;
  • no nome do branch, como acme-42-corrige-login. Maiúsculas e minúsculas não importam;
  • no corpo do PR, logo depois de uma palavra de fechamento: close, closes, closed, fix, fixes, fixed, resolve, resolves ou resolved, como em Closes ACME-42.

Atenção

No corpo do PR, só a forma com palavra de fechamento vincula. Uma menção solta, como "relacionado a ACME-42", não cria vínculo. Se a palavra de fechamento sair do corpo de um PR aberto, o vínculo que ela criou é desfeito.

O prefixo precisa ser o do workspace. Um identificador com o prefixo de outro workspace não é vinculado.

Ver os PRs de uma tarefa

Com a Barra lateral de Pull Request ligada, o detalhe da tarefa ganha a seção Pull requests. Cada PR aparece com:

  • o estado: aberto, rascunho, mesclado ou fechado;
  • o resultado das verificações de CI;
  • se o PR pode receber merge ou tem conflitos.

A lista se atualiza conforme o GitHub envia os eventos do PR.

Concluir a tarefa no merge

Com Concluir tarefa no merge ligado, a tarefa vai para Concluído quando todas estas condições valem:

  • algum PR que recebeu merge cita a tarefa com uma palavra de fechamento no título ou no corpo, como Fixes ACME-42;
  • nenhum outro PR vinculado à tarefa continua aberto ou em rascunho;
  • a tarefa ainda não está num status de conclusão ou de cancelamento.

Um PR vinculado só pelo identificador no título ou no branch, como ACME-42: corrige o login, não conclui a tarefa. Se o mesmo identificador existir em mais de um workspace ligado à instalação, nenhum deles conclui a tarefa automaticamente.

Desconectar

Em Conexão, clique em Desconectar. O Jiraya deixa de receber os eventos dessa instalação, mas mantém os PRs e os vínculos já registrados. Para retomar as atualizações, conecte de novo.

Desconectar não remove o app do GitHub. Para isso, desinstale o GitHub App nas configurações da sua conta ou organização no GitHub. Desinstalar ou suspender o app desliga a integração em todos os workspaces conectados a ele.

Solução de problemas

  • O PR não aparece na tarefa: confira se o identificador está no título, no branch ou no corpo com palavra de fechamento, e se o repositório do PR está entre os que o GitHub App pode ver na instalação.
  • A tarefa não foi concluída no merge: confira se Concluir tarefa no merge está ligado, se o PR usa uma palavra de fechamento e se não há outro PR aberto vinculado à tarefa.
  • O botão Conectar GitHub não responde ou o GitHub recusa a instalação: confira se você é proprietário ou administrador do workspace e administrador da conta ou organização no GitHub.

Próximos passos

  • Use um servidor Git próprio em Git auto-hospedado.
  • Dispare agentes a partir de eventos do GitHub, como uma falha de CI, com um webhook em Autopilots.

Atualizado em

Nesta página