Skip to content

docs: clarify package smoke contract #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CoderDeltaLAN merged 1 commit into from
Jun 17, 2026
Merged

docs: clarify package smoke contract #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
8 changes: 5 additions & 3 deletions docs/V0.2-PACKAGING-DRY-RUN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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:
Expand All @@ -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
Expand All @@ -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.

Expand Down