Story: Decommission legacy ores.codegen bash scripts
Table of Contents
This page documents a story in Sprint 21. It captures the goal, current status, acceptance criteria, and the tasks that compose it.
Goal
No one — human or LLM — should invoke ores.codegen bash scripts directly.
Document scaffolding must go through ores.compass (compass add <type>).
Codegen must go through the Python entry point (codegen.py in
ores.codegen). All legacy bash wrapper scripts in projects/ores.codegen/
that delegate to the Python codegen are to be decommissioned and removed.
The legacy scripts at issue are the thin bash wrappers that call compass.py
or doc_generate.py directly, bypassing the proper CLI layers:
| Script | Replacement |
|---|---|
generate_doc.sh |
compass add <type> |
generate_dq_schema.sh |
codegen.py generate --profile all-sql |
generate_trade_schema.sh |
codegen.py generate --profile all-sql |
generate_workflow_schema.sh |
codegen.py generate --profile all-sql |
generate_workspace_entities.sh |
codegen.py generate |
generate_crypto_refdata.sh |
codegen.py generate |
generate_flags_refdata.sh |
codegen.py generate |
generate_fpml_refdata.sh |
codegen.py generate |
generate_ip2country_refdata.sh |
codegen.py generate |
generate_solvaris_refdata.sh |
codegen.py generate |
generate_trading_instruments.sh |
codegen.py generate |
Infrastructure scripts (validate_docs.sh, plantuml_er_generate.sh,
run_generator.sh, codegen.sh) are not wrappers and remain in scope only
if they have a clear replacement.
Status
| Field | Value |
|---|---|
| State | BACKLOG |
| Parent sprint | Sprint 21 |
| Now | Not yet started. |
| Waiting on | Nothing. |
| Next | Start task_remove_generate_doc_sh. |
| Last touched | 2026-05-30 |
Acceptance
generate_doc.shremoved; all references updated tocompass add.- All SQL-schema bash wrappers removed; replaced by
codegen.pyinvocations. - All data-generation bash wrappers audited and either replaced or promoted to
first-class
codegen.pysubcommands with a capture filed for the latter. - No CI or build step calls a removed script.
- Site builds cleanly.
Tasks
| Task | State | Start | End | Description |
|---|---|---|---|---|
| Remove generate_doc.sh | BACKLOG | Add runbook type to compass; update Group D docs; redeploy settings; delete script. |
Decisions
Out of scope
validate_docs.sh— doc validation tool, not a codegen wrapper.plantuml_er_generate.sh— ER diagram generator, separate concern.run_generator.sh— Dogen C++ generator, no Python codegen replacement.codegen.sh— assess separately; may be a Dogen wrapper, not a doc scaffold.