diff --git a/CHANGELOG.md b/CHANGELOG.md index d551cf5..cf3e6a1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -25,6 +25,7 @@ This project has a published GitHub Release line, but no stable support or API g ### Changed +- Clarified packaging smoke documentation to distinguish console-script execution from `python -m agent_rules_kit.cli` module execution. - Clarified README installation, normal CLI usage, development virtual environment requirements, local checks, and next-release audit readiness. - Added Ruff linting to local checks and CI by installing project development dependencies before running `./scripts/check.sh`. - Synced product strategy and threat model wording with the published `v0.2.0` release line and unreleased post-`v0.2.0` main state. diff --git a/docs/V0.2-PACKAGING-DRY-RUN.md b/docs/V0.2-PACKAGING-DRY-RUN.md index 2ade44c..1c41839 100644 --- a/docs/V0.2-PACKAGING-DRY-RUN.md +++ b/docs/V0.2-PACKAGING-DRY-RUN.md @@ -48,6 +48,8 @@ The dry-run used a temporary directory outside the repository. The dry-run verified: +Package-level execution with `python -m agent_rules_kit` is not part of this smoke contract unless the package later adds `agent_rules_kit/__main__.py`. The verified module-execution form is `python -m agent_rules_kit.cli`. + - `python -m build --sdist --wheel`; - wheel artifact generation; - sdist artifact generation; @@ -95,7 +97,7 @@ Wheel installation result: - installed successfully in a clean virtual environment; - `pip check` reported no broken requirements; - console script executed; -- module execution executed; +- module execution via `python -m agent_rules_kit.cli` executed; - governance output worked. Sdist installation result: @@ -104,7 +106,7 @@ Sdist installation result: - installed successfully; - `pip check` reported no broken requirements; - console script executed; -- module execution executed; +- module execution via `python -m agent_rules_kit.cli` executed; - governance output worked. ## Warnings observed @@ -113,7 +115,7 @@ The dry-run emitted pip cache warnings: - `WARNING: Cache entry deserialization failed, entry ignored`. -These warnings did not block installation, `pip check`, console-script execution, module execution, or governance output smoke tests. +These warnings did not block installation, `pip check`, console-script execution, module execution via `python -m agent_rules_kit.cli`, or governance output smoke tests. They are treated as non-blocking local pip cache noise for this dry-run.