Adiciona README.md: mapa do repositório (branches, tags, por onde começar)
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
35
README.md
Normal file
35
README.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# ampmInsights
|
||||
|
||||
Oracle APEX + AI Vector Search (Select AI / ONNX embeddings) para gestão de vulnerabilidades e
|
||||
CMDB do cliente AM/PM (grupo Ultrapar). Repositório central do projeto — antes disso, o trabalho
|
||||
vivia em pastas locais soltas, sem remoto.
|
||||
|
||||
## Estrutura deste repositório
|
||||
|
||||
| Branch | O que é | Status |
|
||||
|---|---|---|
|
||||
| `main` | **V2** — segunda geração, trabalho ativo. Fork de V1 (09/09/2026) + overhaul de schema (v2.0.0) para expor CVE/pacote/remediação ao AI Insight. | 🚧 Em desenvolvimento, nada executado em banco ainda |
|
||||
| `v1-cliente-frozen` (ver branch `src/branch/v1-cliente-frozen`) | **V1** — pacote cliente-facing, tags `v1.0.0`→`v1.3.0`. É exatamente o que está implementado e validado no ambiente do cliente hoje. | 🔒 Congelado, só leitura — não editar |
|
||||
|
||||
Tags `v1.0.0`–`v1.3.0` (na branch `v1-cliente-frozen`) e `v2.0.0-fork-baseline` (nesta branch)
|
||||
preservam o histórico completo de releases.
|
||||
|
||||
## Por onde começar
|
||||
|
||||
- **Board de tarefas / próximos passos:** [TASKS.md](TASKS.md)
|
||||
- **Histórico de versões da V2:** [CHANGELOG.md](CHANGELOG.md)
|
||||
- **Mapeamento de gap de schema (v1.4.0→v2.0.0):** `../ANALISE_DADOS_v1.4.0_gap_schema.md` (fora
|
||||
deste repo por enquanto — planejamento interno, ainda não movido para cá)
|
||||
- **Documentação passo a passo (instalação, arquitetura, operação):** [docs/](docs/) —
|
||||
`docs/index.html`, publicado também como página única navegável (ver TASKS.md para o link
|
||||
quando existir)
|
||||
- **Regra de ouro do release:** v2.0.0 chega ao ambiente do cliente por evolução **aditiva**
|
||||
(`ALTER TABLE`, tabelas novas, `MERGE`) — nunca `DROP`+recriação.
|
||||
|
||||
## O que NÃO fazer
|
||||
|
||||
- Não editar a branch `v1-cliente-frozen` — ela precisa continuar espelhando exatamente o que
|
||||
está validado e rodando no cliente.
|
||||
- Não commitar segredos: tokens, senhas de banco/wallet, exports brutos de CMDB/Vulnerabilidades
|
||||
(contêm dados reais de outras empresas do grupo Ultrapar — Ipiranga, Ultrapar, Iconic). Ver
|
||||
`.gitignore` e a seção de segurança em `docs/07-seguranca-boas-praticas.html`.
|
||||
Reference in New Issue
Block a user