Handbook

Release checklist (forge-lcdl)

Use this ordered list before tagging or publishing an alpha (or routine) revision.

Updated

CI / handbook gates (mirror automation)

These mirror .github/workflows/ci.yml + handbook job:

  • python -m compileall -q src tests scripts examples
  • python3 scripts/audit_docs_site.py --strict
  • python3 scripts/audit_contract_docs.py --strict --strict-md
  • python3 scripts/audit_contract_docs.py --require-contract-identity
  • python3 scripts/audit_contract_docs.py --schema-depth-report
  • python3 scripts/generate_task_catalog_md.py --check
  • pytest -q tests/docs tests/reference tests/examples
  • pytest -q

Handbook submodule job (website repo): build-site.py --link-check, check-generated-site.py --strict-diagrams --verify-rendered-diagrams, verify-hosting-target.sh.

Library release steps

  1. Unit tests — python3 -m pytest -q (or rely on CI equivalent).
  2. Compile check — python3 -m compileall -q src tests.
  3. Offline benchmarks — From repo root, with src on the module path (same as pytest’s pythonpath in pyproject.toml; omit the prefix if you already ran pip install -e '.[dev]'):
  4. PYTHONPATH=src python3 -m forge_lcdl.benchmarks.runner --suite cheap_model_baseline --out /tmp/lcdl-baseline.json
  5. PYTHONPATH=src python3 -m forge_lcdl.benchmarks.runner --suite lcdl_dogfood_alpha --out /tmp/lcdl-dogfood.json
    Expect failed=0 for both (no --live).
  6. Consolidated smoke — python3 scripts/lcdl_alpha_check.py (use python3 scripts/lcdl_alpha_check.py --skip-pytest only for quick local iteration; run without --skip-pytest before release).
  7. Secrets — Confirm no API keys, tokens, or private env files are staged or committed.
  8. Cursor pack — Critical .cursor/ paths are covered by tests/test_cursor_integration_pack.py (also checked by lcdl_alpha_check.py).
  9. Docs — User-facing behavior changes reflected in docs/; review KNOWN-LIMITATIONS.md for accuracy.
  10. Honest scope — ALPHA-ROADMAP.md still matches what you are shipping.
  11. Migrations — Breaking tasks documented via Migration guides.