Visão Geral da Integração Git - Archyl Docs

Conecte seus repositórios Git para habilitar a descoberta de arquitetura com IA

Visão Geral da Integração Git

Conectar seu repositório Git ao Archyl habilita a descoberta de arquitetura com IA, mantendo sua documentação em sincronia com o código real.

Provedores Suportados

Archyl suporta todas as principais plataformas de hospedagem Git:

Provedores em Nuvem

Provedor OAuth Funcionalidades
GitHub Sim Suporte completo
GitLab Sim Suporte completo
Bitbucket Sim Suporte completo

Auto-hospedado

Provedor Método de Autenticação Funcionalidades
GitHub Enterprise Token Suporte completo
GitLab Auto-gerenciado Token Suporte completo
Gitea Token Suporte completo
Azure DevOps Token Suporte completo

Conectando um Repositório

Passo 1: Navegar até as Configurações do Projeto

  1. Abra seu projeto
  2. Clique em Configurações
  3. Vá para a aba "Repositório"

Passo 2: Escolher o Provedor

  1. Clique em "Conectar Repositório"
  2. Selecione seu provedor Git
  3. Autorize o Archyl (para provedores OAuth)

Passo 3: Selecionar o Repositório

  1. Navegue pelos seus repositórios disponíveis
  2. Selecione o repositório para conectar
  3. Escolha a branch padrão
  4. Clique em "Conectar"

Autenticação

OAuth (Recomendado)

Para GitHub, GitLab e Bitbucket em nuvem:

  1. Clique em "Conectar com [Provedor]"
  2. Autorize o Archyl no popup
  3. Selecione os repositórios para conceder acesso

Tokens OAuth são armazenados com segurança e atualizados automaticamente.

Tokens de Acesso Pessoal

Para provedores auto-hospedados ou enterprise:

  1. Gere um token no seu provedor Git
  2. Escopos necessários: repo (acesso de leitura)
  3. Insira o token no Archyl

Acesso ao Repositório

O que o Archyl Lê

Durante a Descoberta com IA, o Archyl lê:

  • Estrutura e nomes de arquivos
  • Conteúdo do código-fonte
  • Arquivos de configuração (package.json, go.mod, etc.)
  • Arquivos README

O que o Archyl Nunca Acessa

  • Arquivos de ambiente (.env)
  • Credenciais ou segredos
  • Histórico do Git
  • Outras branches (a menos que explicitamente selecionadas)

Múltiplos Repositórios

Conecte múltiplos repositórios a um único projeto:

Monorepo

Para monorepos, conecte uma vez e especifique os caminhos:

/services/api
/services/web
/packages/shared

Multi-Repo

Para repositórios separados:

  1. Conecte cada repositório
  2. Mapeie para sistemas ou contêineres
  3. A descoberta é executada em todos os repos

Webhooks (Em Breve)

Sincronização automática ao fazer push:

  • Acionar descoberta em alterações de código
  • Atualizar arquitetura automaticamente
  • Manter documentação atualizada

Solução de Problemas

Falha na Autorização

  • Verifique se seu token tem as permissões necessárias
  • Certifique-se de que o app OAuth está autorizado
  • Tente reconectar

Repositório Não Encontrado

  • Verifique se você tem acesso ao repositório
  • Confira a URL do repositório
  • Certifique-se de que a branch existe

Erros de Descoberta

  • Verifique caminhos excluídos
  • Reduza as configurações de concorrência
  • Revise os limites do provedor de IA