ADR 0008 — Código no GitHub e documentação no repositório¶
Status: Aceita · Data: 09/11/2026
Contexto¶
Sem controle de versão, atualizações circulam como pacotes copiados à mão, a documentação se espalha em arquivos soltos, e não há histórico de mudanças nem forma segura de voltar a uma versão anterior.
Decisão¶
- Código em repositório no GitHub (
noc-ftth). - Documentação em
docs/, no mesmo repositório, publicada pelo próprio sistema em/docs. - Partes geradas automaticamente: modelo de dados (
gerar_doc_modelo) e API (OpenAPI). - O CI (GitHub Actions) bloqueia commits com testes falhando, migração faltando ou documentação gerada desatualizada.
- Versões marcadas com tags (
v0.1.0,v0.2.0…). O servidor atualiza comscripts/atualizar.sh. - O repositório é genérico: nenhum dado de uma instalação específica (IPs, credenciais, domínio, inventário) vai para o Git.
Alternativas consideradas¶
- Gitea auto-hospedado: controle total, mas mais um serviço para manter e fazer backup, e o CI exigiria um runner próprio.
Consequências¶
O servidor precisa de acesso de leitura ao repositório, por deploy key SSH quando o repositório for privado. Ver Instalação.