TMF/ci-shared
Watch
3
0
Fork
You've already forked ci-shared
 0
Code Pull requests Projects Releases Packages Wiki Activity Actions

fix(generate-docs): OpenAPI contra o Postgres do job e docstrings atrás de docs_docstrings [INFRA-70010] #155

Merged
tmf-ia merged 2 commits from fix/INFRA-70010-generate-docs-openapi into develop 2026-10-27 19:29:47 -03:00
Conversation 0 Commits 2 Files changed 10 +171 -18
tmf-ia commented 2026-10-27 19:15:13 -03:00
Owner
Copy link

O quê

Conserta o reusável generate-docs.yml. [INFRA-70010]

  1. OpenAPI contra o Postgres descartável do job. O passo não definia POSTGRES_URL e o import app.main do HelpCor levantava RuntimeError (contorno no caller: openapi: false). Com openapi: true (padrão), sobe o mesmo Postgres do docs_schema_snapshot (servicos-efemeros.sh) e o novo subcomando docs-schema-descartavel.sh openapi exporta POSTGRES_URL = DATABASE_URL do efêmero, com a mesma guarda tmf-ci-svc-pg-*. Sem banco → ::error::. Sem continue-on-error.
  2. Docstrings atrás de docs_docstrings (chave do ci-config, padrão false; schema + exemplo + ci_config.py). O extract_docstrings gerava docs/modulos/<m>/api-internal.md fora do mapa-alvo e sem front-matter (o 1º PR chore(docs) reprovaria no verificar-docs estrito). A chave é reservada: ligada, recusa com ::error:: até o destino da referência gerada (ADR 0012, emenda de 14/10) ser definido.

Custo

Todo produto com openapi: true passa a subir um Postgres efêmero no job de docs (o generate-docs roda no workflow de docs do produto, não em todo PR).

Testes

  • tests/generate-docs: 36 OK (7 novos); tests/ci-config: 183 OK.
  • Suíte inteira na imagem tmf-ci-python:3.12-20261009-2e51884: todas OK. bash -n e YAML válidos.

Fora deste PR

Critério "Generate Docs verde no HelpCor sem openapi: false" se prova no HelpCor depois da release do ci-shared (a sessão do HelpCor tira o contorno).

🤖 Generated with Claude Code

https://claude.ai/code/session_01ES1xwVdpQV69zEsuLLKzx2

## O quê Conserta o reusável `generate-docs.yml`. [INFRA-70010] 1. **OpenAPI contra o Postgres descartável do job.** O passo não definia `POSTGRES_URL` e o `import app.main` do HelpCor levantava `RuntimeError` (contorno no caller: `openapi: false`). Com `openapi: true` (padrão), sobe o **mesmo** Postgres do `docs_schema_snapshot` (`servicos-efemeros.sh`) e o novo subcomando `docs-schema-descartavel.sh openapi` exporta `POSTGRES_URL` = `DATABASE_URL` do efêmero, com a mesma guarda `tmf-ci-svc-pg-*`. Sem banco → `::error::`. **Sem `continue-on-error`.** 2. **Docstrings atrás de `docs_docstrings`** (chave do `ci-config`, padrão `false`; schema + exemplo + `ci_config.py`). O `extract_docstrings` gerava `docs/modulos/<m>/api-internal.md` fora do mapa-alvo e sem front-matter (o 1º PR `chore(docs)` reprovaria no verificar-docs estrito). A chave é **reservada**: ligada, recusa com `::error::` até o destino da referência gerada (ADR 0012, emenda de 14/10) ser definido. ## Custo Todo produto com `openapi: true` passa a subir um Postgres efêmero no job de docs (o generate-docs roda no workflow de docs do produto, não em todo PR). ## Testes - `tests/generate-docs`: 36 OK (7 novos); `tests/ci-config`: 183 OK. - Suíte inteira na imagem `tmf-ci-python:3.12-20261009-2e51884`: todas OK. `bash -n` e YAML válidos. ## Fora deste PR Critério "Generate Docs verde no HelpCor sem `openapi: false`" se prova no HelpCor depois da release do ci-shared (a sessão do HelpCor tira o contorno). 🤖 Generated with [Claude Code](https://claude.com/claude-code) https://claude.ai/code/session_01ES1xwVdpQV69zEsuLLKzx2 
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Claude-Session: https://claude.ai/code/session_01ES1xwVdpQV69zEsuLLKzx2
merge: develop em fix/INFRA-70010-generate-docs-openapi (CHANGELOG: Adicionado + Corrigido) [INFRA-70010]
All checks were successful
PR checks (ci-shared) / testes (pull_request) Successful in 5m25s
Details
3cf306493a
tmf-ia merged commit dbaf22529d into develop 2026-10-27 19:29:47 -03:00
Sign in to join this conversation.
Reviewers
No reviewers
tarcisio
Labels
Clear labels
  
seguranca
Segurança/LGPD — merge só com aprovação do operador

No labels
seguranca
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
TMF/ci-shared!155
No description provided.