Skip to content

docs: incorpora resultados dos testes do PNCP ComprasGOV - #71

Open
LarrissaSilva wants to merge 1 commit into
docs-projeto-mvpfrom
docs/atualiza-documentacao-testes
Open

docs: incorpora resultados dos testes do PNCP ComprasGOV#71
LarrissaSilva wants to merge 1 commit into
docs-projeto-mvpfrom
docs/atualiza-documentacao-testes

Conversation

@LarrissaSilva

@LarrissaSilva LarrissaSilva commented Aug 12, 2026

Copy link
Copy Markdown
Collaborator

O que muda com este PR

Este PR integra à documentação os resultados dos testes locais realizados no projeto Colibri, principalmente no pipeline PNCP ComprasGOV.

As alterações:

  • documentam os requisitos operacionais da carga do ComprasGOV;
  • orientam o uso explícito de --bucket em ambientes de teste;
  • acrescentam uma seção de solução de problemas;
  • registram as salvaguardas já implementadas na conversão para Parquet, chamada do dbt e atualização do manifesto;
  • acrescentam um roteiro de validação manual do pipeline;
  • corrigem exemplos que utilizavam comandos ou modelos inexistentes;
  • atualizam a lista de tabelas disponíveis no catálogo.

Como testar

  • Executar git diff --check.
  • Confirmar que os modelos mencionados correspondem aos arquivos existentes em dbt/modelos/marts/pncp_comprasgov.
  • Confirmar que não há referências a resumo_anual, lake q, colibri doctor ou opções ainda não implementadas.
  • Renderização com Quarto não executada localmente, pois o Quarto não estava instalado no ambiente.

@heitorgama e @yolile, poderiam avaliar esta atualização da documentação, por favor?

Comment thread docs/06-guia-analista.qmd
O comando correto é `colibri lake query`, não `colibri lake q` — essa
abreviação aparece por engano em alguns exemplos mais antigos.
Use sempre o nome completo do comando, `colibri lake query`; abreviações que
aparecem em exemplos antigos não são aceitas pela CLI atual.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Talvez seja melhor fazer uma refatoração completa para usar a terminologia atual de forma consistente em toda a documentação?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Concordo.

`baixar_catalogo.py`, `manifesto_bucket.py`, `salvar_arquivo_no_bucket.py`,
`csv_para_parquet.py`, `ducklake.py`, entre outros.

## Validação local do PNCP ComprasGOV

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Talvez fosse conveniente adicionar uma nova seção sobre Pipelines em geral e incluir os detalhes sobre o Comprasgov lá, e no futuro sobre outros Pipelines?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Boa sugestão, @yolile! Concordo com essa organização. Vou aguardar também a revisão do Heitor e, depois, reúno os feedbacks para fazer os ajustes em um único commit.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Também estava querendo escrever sobre cada pipeline, sua lógica, a origem dos dados, como ele é atualizado etc. Vamos fazer isso em uma nova seção, sim! :)

Comment on lines -133 to +173
exige rodar, na raiz do repositório:
exige rodar os testes automatizados, na raiz do repositório:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Acredito que, se meu PR de CI automático for combinado, esta seção e prática não serão mais necessárias. FYI

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfeito, @yolile! Obrigada pelo aviso. Quando o PR de CI for incorporado, posso revisar essa seção e retirar as instruções manuais que forem substituídas pela automação.

@heitorgama heitorgama left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ótimos ajustes, Larrissa! Obrigado

`baixar_catalogo.py`, `manifesto_bucket.py`, `salvar_arquivo_no_bucket.py`,
`csv_para_parquet.py`, `ducklake.py`, entre outros.

## Validação local do PNCP ComprasGOV

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Também estava querendo escrever sobre cada pipeline, sua lógica, a origem dos dados, como ele é atualizado etc. Vamos fazer isso em uma nova seção, sim! :)

@maia-andre

Copy link
Copy Markdown
Collaborator

Oi @LarrissaSilva! Complemento rápido, nada aqui parece precisar segurar o merge. Caçando comandos inexistentes hoje (mesma missão do seu PR), achei dois casos que já estavam na doc antes dele e seguem lá; deixo registrado para um follow-up:

De resto, as correções de exemplos (lake q, resumo_anual) batem certinho com o catálogo real de hoje.

Aproveitando a passagem: o PR está aprovado e sem conflito, e pelo que li a única dúvida é de sequência. @LarrissaSilva, você ainda pretende aquele commit reunindo os feedbacks, ou as sugestões da @yolile podem virar follow-ups? (Uma delas, como a própria yolile apontou, depende do PR de CI #69 entrar primeiro.) Se a resposta for follow-up, @heitorgama, talvez já dê para mergear e a doc atualizada entra no ar

@LarrissaSilva

Copy link
Copy Markdown
Collaborator Author

@maia-andre, obrigada pela revisão e pelo levantamento. Como o comportamento do colibri lake years ainda vai ser decidido na #80 e uma das sugestões da @yolile depende do PR #69, acredito que seja melhor tratar esses pontos como follow-ups, incluindo a correção de colibri lake tabelas para colibri lake tables. Da minha parte, não pretendo adicionar outro commit neste PR. @heitorgama, pode fazer o merge quando considerar adequado. Obrigada.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants