From 6d2a649e4e11f48ff9fd751fbeede0fdb5ec9873 Mon Sep 17 00:00:00 2001 From: Jeffrey Phillips Freeman Date: Sat, 4 Apr 2026 19:14:45 +0000 Subject: [PATCH] docs: update plan CLI and CI/CD docs for unreleased features MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - plan_cli.md: add warning admonition for legacy/v3 plan workflow mixing detection (#1577) — agents plan commands now reject mixed legacy+v3 usage - ci-cd.md: document pre-migrated database template optimization (#2334) — all test suites now use CLEVERAGENTS_TEMPLATE_DB to skip redundant Alembic migrations; slow_integration_tests upgraded to pabot --- docs/development/ci-cd.md | 13 +++++++++++++ docs/reference/plan_cli.md | 7 +++++++ 2 files changed, 20 insertions(+) diff --git a/docs/development/ci-cd.md b/docs/development/ci-cd.md index 6f6bf7486..cc9c0a75a 100644 --- a/docs/development/ci-cd.md +++ b/docs/development/ci-cd.md @@ -171,6 +171,19 @@ tools directly. This ensures that the CI environment matches local development exactly. Each job runs `pip install uv nox` and then delegates to the appropriate nox session. +### Pre-Migrated Database Template + +All nox test sessions (`unit_tests`, `integration_tests`, `slow_integration_tests`, +`e2e_tests`, `coverage_report`) use a **pre-migrated database template** to +eliminate redundant Alembic migrations across test runs. The template is created +once via `_create_template_db()` and the path is passed to each session via the +`CLEVERAGENTS_TEMPLATE_DB` environment variable. Each test worker copies the +template rather than running migrations from scratch, significantly reducing +total test suite wall-clock time. + +`slow_integration_tests` uses `pabot` (parallel Robot Framework runner) for +consistency with `integration_tests`. (#2334) + ### Quality Gates Summary All gates must pass for a PR to be mergeable: diff --git a/docs/reference/plan_cli.md b/docs/reference/plan_cli.md index 17c7e5d83..f3a975900 100644 --- a/docs/reference/plan_cli.md +++ b/docs/reference/plan_cli.md @@ -2,6 +2,13 @@ The `agents plan` command group manages plans in the CleverAgents v3 plan lifecycle. +!!! warning "Legacy/v3 Plan Workflow Mixing" + `agents plan` commands detect and reject attempts to mix legacy plan commands + with v3 plan workflows in the same session. If you attempt to use a legacy + plan command alongside v3 commands, the CLI surfaces a clear error message + with migration guidance. Migrate all plan workflows to v3 before mixing + commands in a single session. (#1577) + ## Commands | Command | Description |