Skip to content

docs: target the 0.5 minor release line #440

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
codeforester merged 1 commit into from
Oct 9, 2026
Merged

docs: target the 0.5 minor release line #440

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
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 4 additions & 3 deletions docs/adopter-readiness.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
4 changes: 3 additions & 1 deletion docs/api-stability.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading