Documentação

Conecte seu código

Vincule um repositório GitHub ou GitLab para que o Coroid tenha onde ler e abrir pull requests.

O Coroid precisa de acesso a um repositório antes de poder fazer qualquer coisa. Você conecta um provedor de controle de versão uma vez no nível da organização e depois vincula repositórios individuais aos Projetos.

As Conexões são gerenciadas em Configurações → Conexões → Controle de versão (/settings/connections/source-control).

Provedores compatíveis

ProvedorMétodo de conexãoDisponibilidade
GitHubInstalação do App do GitHub ou um token de acesso pessoalDisponível para todos
GitLabToken de acesso pessoalVisualização privada

GitHub: Instalação do App ou token

Para o GitHub, instalar o App do Coroid para GitHub é a melhor opção. O App concede acesso por repositório em vez de por usuário, continua funcionando mesmo quando a pessoa que o configurou sai da empresa e permite que o Coroid receba eventos de webhook sem precisar fazer polling.

Escolha um token de acesso pessoal quando a instalação do App exigir aprovação de administrador que você não possui.

Para instalar o App, vá até Configurações → Conexões → Controle de versão, selecione GitHub, e siga o fluxo de instalação. O GitHub perguntará quais repositórios devem ter acesso concedido; você pode alterar isso posteriormente nas configurações próprias do GitHub.

Conectando com um token de acesso pessoal

Crie o token no seu provedor e cole-o em Configurações → Conexões → Controle de versão.

O token precisa ler o conteúdo do repositório e criar branches e pull requests. No GitHub, esse é o escopo de um token clássico; no GitHub, é repo escopo para um token clássico; no GitLab, é api.

Os tokens são criptografados antes de serem armazenados e nunca são retornados pelo API nem exibidos novamente na interface após serem salvos. Eles também são excluídos dos pacotes de exportação de configurações — um pacote exportado contém um placeholder, e você precisa inserir o segredo novamente ao importá-lo em outro lugar.

Vincular um repositório a um projeto

Uma conexão disponibiliza os repositórios; um projeto é onde o Coroid realmente trabalha. Crie um em Projetos → Novo, selecione o repositório conectado e o Coroid fará uma primeira análise do código-fonte para detectar linguagens, comandos de build e comandos de teste.

Essa primeira análise é o que permite que um agente compile e teste seu projeto; por isso, vale a pena verificar o resultado. Você pode corrigir qualquer inferência incorreta nas configurações do projeto.

De qual branch o Coroid trabalha

O Coroid parte da sua branch padrão e abre pull requests voltados para ela. Você pode alterar a branch base por projeto nas configurações de repositório do projeto se for mesclar em algo diferente de main.

Verificar a conexão

A conexão está funcionando quando o repositório aparece na lista de criação de projetos e a primeira análise do projeto é concluída. Se um repositório esperado estiver ausente, as causas mais comuns são:

  • o App do GitHub foi instalado, mas não recebeu acesso a esse repositório específico
  • o escopo do token é muito restrito para listar repositórios privados
  • o repositório pertence a uma organização diferente daquela que você conectou

Próximo

Como uma tarefa se torna um pull request — o que acontece depois de você descrever algum trabalho.