From 6740646d115980a2f13983271584b98c2c82958e Mon Sep 17 00:00:00 2001 From: GitHub Copilot Date: Wed, 11 Mar 2026 03:35:30 +0000 Subject: [PATCH] docs: update documentation for changes from 2026-03-11 - Add CHANGELOG entry for cli.py/apm_package.py refactoring into focused commands modules (PR #224, issue #172) - Update pack command docs: add 'copilot' as primary target name, 'vscode' as alias; update target filtering table and example (PR #228) - Update runtime-integration.md: fix cli.py reference to point at the correct module after refactoring (src/apm_cli/commands/runtime.py) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- CHANGELOG.md | 4 ++++ docs/cli-reference.md | 17 +++++++++-------- docs/runtime-integration.md | 2 +- 3 files changed, 14 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1e35f6af..d5f8fd02 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +### Changed + +- Refactor `cli.py` and `apm_package.py` into focused modules — `cli.py` is now a thin 80-line wiring layer; all command logic lives in `apm_cli.commands.*` modules (#224) + ## [0.7.7] - 2026-03-10 ### Added diff --git a/docs/cli-reference.md b/docs/cli-reference.md index 60a96e85..2a994d91 100644 --- a/docs/cli-reference.md +++ b/docs/cli-reference.md @@ -345,7 +345,7 @@ apm pack [OPTIONS] **Options:** - `-o, --output TEXT` - Output directory (default: `./build/`) -- `-t, --target [vscode|claude|all]` - Filter files by target. Auto-detects from `apm.yml` if not specified +- `-t, --target [copilot|vscode|claude|all]` - Filter files by target. `vscode` is an alias for `copilot`. Auto-detects from `apm.yml` if not specified - `--archive` - Produce a `.tar.gz` archive instead of a directory - `--dry-run` - List files that would be packed without writing anything - `--format [apm|plugin]` - Bundle format (default: `apm`) @@ -358,8 +358,8 @@ apm pack # Pack as a .tar.gz archive apm pack --archive -# Pack only VS Code / Copilot files -apm pack --target vscode +# Pack only GitHub Copilot / VS Code files +apm pack --target copilot # Preview what would be packed apm pack --dry-run @@ -375,11 +375,12 @@ apm pack -o dist/ **Target filtering:** -| Target | Includes paths starting with | -|--------|------------------------------| -| `vscode` | `.github/` | -| `claude` | `.claude/` | -| `all` | both | +| Target | Includes paths starting with | Notes | +|--------|------------------------------|-------| +| `copilot` | `.github/` | Primary name for GitHub Copilot / Cursor / Codex / Gemini | +| `vscode` | `.github/` | Alias for `copilot` | +| `claude` | `.claude/` | | +| `all` | both | | **Enriched lockfile example:** ```yaml diff --git a/docs/runtime-integration.md b/docs/runtime-integration.md index 9e4e061b..b02bacee 100644 --- a/docs/runtime-integration.md +++ b/docs/runtime-integration.md @@ -226,7 +226,7 @@ APM's runtime system consists of three main components: 1. **Create Runtime Adapter** - Extend `RuntimeAdapter` in `src/apm_cli/runtime/your_runtime.py` 2. **Create Setup Script** - Add installation script in `scripts/runtime/setup-your-runtime.sh` 3. **Register Runtime** - Add entry to `supported_runtimes` in `RuntimeManager` -4. **Update CLI** - Add runtime to command choices in `cli.py` +4. **Update CLI** - Add runtime to command choices in `src/apm_cli/commands/runtime.py` 5. **Update Factory** - Add runtime to `RuntimeFactory` ### Best Practices