Skip to content

docs: update post-release status #16

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 9, 2026
Merged

docs: update post-release status #16

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
5 changes: 4 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@ This project has no stable public release yet.

## [Unreleased]

No unreleased changes yet.
### Changed

- Updated README status after publishing `v0.1.0` as a GitHub pre-release.
- Added basic installation guidance for release artifacts.

## [0.1.0] - 2026-06-09

Expand Down
27 changes: 22 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,12 +150,26 @@ A clean report means only that the implemented baseline checks did not find a su

---

## Commands
## Installation

`v0.1.0` is available as GitHub pre-release artifacts.

This project is not published to PyPI yet.

Download the wheel from the `v0.1.0` GitHub Release, then install it in a virtual environment:

python -m venv .venv
.venv/bin/python -m pip install ./agent_rules_kit-0.1.0-py3-none-any.whl
.venv/bin/agent-rules-kit --version

The project can currently be used from the source tree with:
The source tree can still be used directly for development:

PYTHONPATH=src python -m agent_rules_kit.cli --help

---

## Commands

### Check a repository

PYTHONPATH=src python -m agent_rules_kit.cli check tests/fixtures/repositories/single-agent
Expand Down Expand Up @@ -313,21 +327,24 @@ The required status check for `main` is:

Current status:

- v0.1.0 release-candidate documentation stage;
- `v0.1.0` is published as a GitHub pre-release;
- no public stable release yet;
- release tag `v0.1.0` points to the verified release SHA;
- wheel and sdist artifacts are attached to the GitHub Release;
- release assets were downloaded, checksum-verified, installed, and smoke-tested;
- local CLI behavior implemented;
- packaging verified from real sdist and wheel artifacts;
- CI active;
- branch protection active;
- README reflects current behavior only;
- security boundaries documented;
- threat model documented.

Before a public release, verify:
For future releases, verify:

- local checks pass;
- CI passes for the release SHA;
- sdist and wheel build and install from clean temporary environments;
- release assets can be downloaded, checksum-verified, installed, and smoke-tested;
- output examples are generated from real commands;
- README does not claim unsupported maturity;
- SECURITY.md and CHANGELOG.md are current;
Expand Down
Loading