feat(cli): stabilize action/plan output formats #240

New issue

Closed

opened 2026-02-22 23:40:26 +00:00 by freemo · 1 comment

freemo commented

2026-02-22 23:40:26 +00:00

Owner

Metadata

Commit: feat(cli): stabilize action/plan output formats
Branch: feature/m1-cli-formats

Subtasks

Ensure --format json|yaml|plain|table|rich parity for action/plan list/show/status outputs.
Normalize output keys to spec field names (namespaced_name, processing_state, project_links, arguments, automation_profile).
Update docs/reference/action_cli.md + docs/reference/plan_cli.md with format examples and field descriptions.
Tests (Behave): Add format output scenarios for json/yaml on action/plan list/show/status.
Tests (Robot): Add Robot lifecycle flow verifying formatted outputs remain stable.
Tests (ASV): Add benchmarks/cli_format_bench.py for serialization overhead.
Run nox (all default sessions, including benchmark), fix any errors if needed ensuring nox passes.
Verify coverage >=97% via nox -s coverage_report. If coverage is <97% then review the current unit test coverage report at build/coverage.xml and use it to write new Behave based unit tests to improve code coverage. Specifically, write Behave style unit tests that are descriptively named and specifically improves coverage on whichever file has the most uncovered lines by writing tests that will target the uncovered lines in the report. Once that is done rerun nox -s coverage_report to verify all tests pass and coverage is above >=97%, if not repeat this task as many times as is needed until coverage reaches >=97%.

Section: #### Section 3 Notes
Status: Completed

## Metadata - **Commit**: `feat(cli): stabilize action/plan output formats` - **Branch**: `feature/m1-cli-formats` ## Subtasks - [x] Ensure `--format json|yaml|plain|table|rich` parity for action/plan list/show/status outputs. - [x] Normalize output keys to spec field names (namespaced_name, processing_state, project_links, arguments, automation_profile). - [x] Update `docs/reference/action_cli.md` + `docs/reference/plan_cli.md` with format examples and field descriptions. - [x] Tests (Behave): Add format output scenarios for json/yaml on action/plan list/show/status. - [x] Tests (Robot): Add Robot lifecycle flow verifying formatted outputs remain stable. - [x] Tests (ASV): Add `benchmarks/cli_format_bench.py` for serialization overhead. - [x] Run `nox` (all default sessions, including benchmark), fix any errors if needed ensuring nox passes. - [x] Verify coverage >=97% via `nox -s coverage_report`. If coverage is <97% then review the current unit test coverage report at `build/coverage.xml` and use it to write new Behave based unit tests to improve code coverage. Specifically, write Behave style unit tests that are descriptively named and specifically improves coverage on whichever file has the most uncovered lines by writing tests that will target the uncovered lines in the report. Once that is done rerun `nox -s coverage_report` to verify all tests pass and coverage is above >=97%, if not repeat this task as many times as is needed until coverage reaches >=97%. **Section**: #### Section 3 Notes **Status**: Completed

freemo added this to the v3.0.0 milestone

2026-02-22 23:40:26 +00:00

freemo added the

labels

2026-02-22 23:40:26 +00:00

freemo self-assigned this

2026-02-22 23:40:26 +00:00

freemo closed this issue

2026-02-22 23:40:27 +00:00

freemo added a new dependency

2026-02-22 23:54:12 +00:00

#350 Epic: Plan Lifecycle A1-A5 (Models & Persistence)

freemo added a new dependency

2026-02-23 01:11:12 +00:00

#60 feature/m1-cli-formats

freemo referenced this issue from a pull request that will close it,

2026-02-23 17:26:01 +00:00

feature/m1-cli-formats #60

freemo commented

2026-02-24 02:30:59 +00:00

Author

Owner

Implementation Notes — A4b.outputs: CLI Output Format Stabilization

2026-02-14: Stage A4b.outputs Complete - CLI Output Format Stabilization

Created formatting.py: shared format_output() helper with OutputFormat enum, JSON/YAML/plain/table/rich serializers. Handles datetime, Enum, nested structures.

(Migrated from docs/implementation-notes.md)

## Implementation Notes — A4b.outputs: CLI Output Format Stabilization **2026-02-14**: Stage A4b.outputs Complete - CLI Output Format Stabilization - Created `formatting.py`: shared `format_output()` helper with `OutputFormat` enum, JSON/YAML/plain/table/rich serializers. Handles datetime, Enum, nested structures. *(Migrated from `docs/implementation-notes.md`)*

freemo removed a dependency

2026-03-03 22:54:43 +00:00

#60 feature/m1-cli-formats

freemo added a new dependency

2026-03-03 22:54:43 +00:00

#60 feature/m1-cli-formats