diff --git a/README.md b/README.md index dec51ff..f9fd70a 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,8 @@ | `0.4.3` | [Apache-2.0](LICENSE) | `python -m pip install base-cli` | [v0.4.3](https://github.com/basefoundry/base-cli/releases/tag/v0.4.3) | Source release candidate: 0.5.0. Publication is pending the [release checklist](docs/release-0.5.0-checklist.md); PyPI remains the authority for available versions. +The adopter documentation uses `~=0.5.0` for the release-preparation target; +use that pin only after the 0.5.0 artifact is published and verified. `base-cli` is the production lifecycle layer for Click and Typer Python CLIs. It standardizes context, logging, configuration, cleanup, and machine-readable diff --git a/docs/adopter-readiness.md b/docs/adopter-readiness.md index 7d63378..0f11d56 100644 --- a/docs/adopter-readiness.md +++ b/docs/adopter-readiness.md @@ -10,9 +10,10 @@ owns product configuration, commands, services, and release policy. Before the first production pilot, the adopter should be able to check every box below: -- [ ] Pin a supported `base-cli` minor release (for example, `~=0.4.0`) and - record Click, the optional YAML extra (when used), and any other integration - versions in a lock file. +- [ ] Pin a supported `base-cli` minor release (for example, `~=0.5.0` for the + 0.5.0 release-preparation target; use it after publication and verification) + and record Click, the optional YAML extra (when used), and any other + integration versions in a lock file. - [ ] Run the adopter's command suite on CPython 3.10--3.14 on every platform the product supports; retain at least one installed-wheel smoke job. - [ ] Use only the documented `base_cli` facade and module `__all__` exports; diff --git a/docs/api-stability.md b/docs/api-stability.md index 2c3eb07..67bf451 100644 --- a/docs/api-stability.md +++ b/docs/api-stability.md @@ -45,7 +45,9 @@ Until 1.0, the leading zero is meaningful: patch releases remain compatible, while a minor release is a compatibility boundary and may contain a breaking change. We still prefer additive changes, and any pre-1.0 break must include a warning where practical, a migration path, and a changelog entry. Consumers -that need a frozen API should pin a minor release (for example, `~=0.4.0`). +that need a frozen API should pin the current minor release (for example, +`~=0.5.0` for the 0.5.0 release-preparation target; use it after publication +and verification). The core package requires Python `>=3.10` and currently tests CPython 3.10 through 3.14 on Linux, macOS, and Windows. The core runtime dependency is