GitHub App e permissões
O HeyDeer funciona por meio de um GitHub App instalado na sua conta pessoal ou organização. Você escolhe quais repositórios o HeyDeer pode ler e revisar.
Instalar o HeyDeer
Cada espaço de trabalho pertence a uma conta do GitHub: uma conta pessoal ou uma organização.
- Selecione Instalar no GitHub ou Instalar em outra conta. Na primeira configuração, essa opção fica em Conecte seus repositórios. Para conectar outra conta depois, selecione primeiro Adicionar espaço de trabalho no menu do espaço de trabalho.
- No GitHub, escolha a conta e depois os repositórios que o HeyDeer pode revisar.
- Confirme no GitHub. Em seguida, o HeyDeer abre o espaço de trabalho da conta.
Em uma organização, só um proprietário pode instalar o GitHub App; caso contrário, o GitHub envia uma solicitação aos proprietários. Enquanto ela estiver pendente, o HeyDeer mostra Aguardando a aprovação de um proprietário do GitHub, e os administradores do espaço de trabalho já podem ajustar as configurações.
Quando um proprietário aprova, o espaço de trabalho se conecta sozinho, e o HeyDeer envia um e-mail ao endereço de notificação do espaço de trabalho.
Adicionar repositórios
No GitHub, escolha Only select repositories e selecione os repositórios a revisar. All repositories também inclui os repositórios criados depois.
Para adicionar repositórios depois, selecione Adicionar repositórios na página Repositórios ou Gerenciar acesso ao GitHub em Configurações do espaço de trabalho → Conexão com o GitHub. Só um proprietário da conta do GitHub pode salvar alterações no GitHub. As demais pessoas veem Pedir ajuda à equipe, com uma solicitação que podem copiar e enviar a um proprietário.
Os repositórios adicionados seguem os padrões do espaço de trabalho em Regras de revisão. Uma pessoa vê um repositório e as revisões dele no HeyDeer quando tanto ela quanto o HeyDeer têm acesso a ele no GitHub. Solicitar uma revisão exige acesso de escrita; consulte Comandos em comentários do PR.
Permissões
| Permissão | Acesso | Para que o HeyDeer a usa |
|---|---|---|
| Contents | Leitura e escrita | Ler código e histórico, resolver as próprias conversas de revisão do HeyDeer e fazer push de branches e commits para correções e solicitações ao @heydeer. |
| Pull requests | Leitura e escrita | Ler pull requests, publicar revisões, comentários e respostas, e abrir, atualizar e fazer merge dos pull requests que você pedir. |
| Workflows | Leitura e escrita | Atualizar arquivos de workflow do GitHub Actions quando uma correção ou solicitação os altera. |
| Checks | Leitura e escrita | Mostrar a verificação HeyDeer Review e receber as solicitações feitas pelos botões dela. |
| Actions | Leitura | Ler os logs de jobs com falha do GitHub Actions para que o Autopilot possa corrigi-los. |
| Issues | Leitura e escrita | Receber menções e comandos do @heydeer, confirmá-los com reações, ler issues relacionadas e abrir e atualizar as issues que você pedir. |
| Metadata | Leitura | Ler informações básicas do repositório e quem tem acesso de escrita. |
| Members (organização) | Leitura | Listar os membros do espaço de trabalho e verificar as condições de membros e equipes nos filtros de revisão automática e em Acesso a revisões manuais. |
| Email addresses (conta) | Leitura | Sugerir seu e-mail verificado como endereço de notificação. |
Se o GitHub não tiver concedido uma permissão de que o HeyDeer precisa, Configurações do espaço de trabalho → Conexão com o GitHub mostra Permissão do GitHub necessária ou Há permissões adicionais do GitHub disponíveis. Um proprietário da conta do GitHub seleciona Revisar solicitação de permissão e a aceita no GitHub.
Para saber como o HeyDeer trata seu código e seus dados, consulte Segurança e tratamento de dados.
Quando uma conta ou um repositório não aparece
Uma organização aparece ao conectar só quando o HeyDeer está instalado nela. Para adicionar uma, selecione Instalar no GitHub ou Instalar em outra conta e escolha-a no GitHub; se você não for proprietário, o GitHub envia uma solicitação aos proprietários. Se uma organização que tem o HeyDeer continuar sem aparecer, entre nela com SSO no GitHub, abra Não vê sua conta? e selecione Entrar novamente no GitHub.
Se uma organização não tinha espaço de trabalho quando um proprietário aprovou sua solicitação, o HeyDeer o cria com você como administrador.
Se o HeyDeer mostrar Restaure seu acesso aos repositórios, sua conta do GitHub não consegue acessar os repositórios aos quais o HeyDeer recebeu acesso. Selecione Atualizar acesso ao GitHub. Consulte Solução de problemas para outros casos.
Quando o acesso do HeyDeer ao GitHub está pausado ou foi removido
Se o HeyDeer for suspenso no GitHub, Configurações do espaço de trabalho → Conexão com o GitHub mostra O acesso ao GitHub está pausado, e as revisões não podem ser executadas. Um proprietário da conta do GitHub seleciona Retomar acesso ao GitHub.
Se o HeyDeer for desinstalado, essa mesma página mostra O HeyDeer foi removido do GitHub. Um proprietário seleciona Reinstalar HeyDeer; o espaço de trabalho mantém as configurações e o histórico de revisões.