diff --git a/CHANGELOG.md b/CHANGELOG.md index f56b246..f558ec7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,11 +7,13 @@ and versions are tracked in the repo-root `VERSION` file. ## [Unreleased] +## [0.2.0] - 2026-10-10 + ### Changed - Align the reference consumer, compatibility matrix, release evidence, and - documentation with the Base-CLI 0.5.0 API line; successful telemetry spans - now assert the 0.5.0 `status=OK` lifecycle contract. + documentation with the released Base-CLI 0.5.x API line; the lockfile now + resolves the published Base-CLI 0.5.1 patch release. ## [0.1.0] - 2026-09-02 diff --git a/README.md b/README.md index f1a3add..a0cbaf8 100644 --- a/README.md +++ b/README.md @@ -143,7 +143,7 @@ python -m pip install ".[dev]" ``` The package requires Python 3.10 or newer and pins the supported Base-CLI line -to `>=0.5.0,<0.6`. This checkout targets the next demo release after `v0.1.0`; +to `>=0.5.0,<0.6`. This checkout prepares demo release `v0.2.0`; demo release versioning remains separate from framework versioning. ## Documentation @@ -155,8 +155,8 @@ release. To start with a minimal consumer rather than the full demo, use the For framework-level material, start at the [Base-CLI repository](https://github.com/basefoundry/base-cli), its -[getting-started guide](https://github.com/basefoundry/base-cli/blob/v0.5.0/README.md#quick-start), -or the [public API reference](https://github.com/basefoundry/base-cli/blob/v0.5.0/docs/api-reference.md). +[getting-started guide](https://github.com/basefoundry/base-cli/blob/v0.5.1/README.md#quick-start), +or the [public API reference](https://github.com/basefoundry/base-cli/blob/v0.5.1/docs/api-reference.md). ## Repository shape diff --git a/VERSION b/VERSION index 6e8bf73..0ea3a94 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -0.1.0 +0.2.0 diff --git a/docs/README.md b/docs/README.md index 0873ccc..ab93374 100644 --- a/docs/README.md +++ b/docs/README.md @@ -26,5 +26,5 @@ the complete Northstar consumer: For the framework's complete material, start at the [Base-CLI repository](https://github.com/basefoundry/base-cli), its -[getting-started guide](https://github.com/basefoundry/base-cli/blob/v0.5.0/README.md#quick-start), -or the [public API reference](https://github.com/basefoundry/base-cli/blob/v0.5.0/docs/api-reference.md). +[getting-started guide](https://github.com/basefoundry/base-cli/blob/v0.5.1/README.md#quick-start), +or the [public API reference](https://github.com/basefoundry/base-cli/blob/v0.5.1/docs/api-reference.md). diff --git a/docs/learning-path.md b/docs/learning-path.md index 84a6424..bfa44a9 100644 --- a/docs/learning-path.md +++ b/docs/learning-path.md @@ -103,10 +103,10 @@ Open `src/base_cli_demo/cli.py` while following the examples: repository conventions mandatory. For deeper framework context, continue with the Base-CLI -[API reference](https://github.com/basefoundry/base-cli/blob/v0.5.0/docs/api-reference.md), -[consumer profiles](https://github.com/basefoundry/base-cli/blob/v0.5.0/docs/consumer-profiles.md), -[output contracts](https://github.com/basefoundry/base-cli/blob/v0.5.0/docs/output-contracts.md), -[JSON contracts](https://github.com/basefoundry/base-cli/blob/v0.5.0/docs/json-contracts.md), +[API reference](https://github.com/basefoundry/base-cli/blob/v0.5.1/docs/api-reference.md), +[consumer profiles](https://github.com/basefoundry/base-cli/blob/v0.5.1/docs/consumer-profiles.md), +[output contracts](https://github.com/basefoundry/base-cli/blob/v0.5.1/docs/output-contracts.md), +[JSON contracts](https://github.com/basefoundry/base-cli/blob/v0.5.1/docs/json-contracts.md), and [testing guide](https://github.com/basefoundry/base-cli/blob/main/docs/testing.md). ## Current behavior and future scope diff --git a/docs/should-i-use-base-cli.md b/docs/should-i-use-base-cli.md index f222c7c..9174590 100644 --- a/docs/should-i-use-base-cli.md +++ b/docs/should-i-use-base-cli.md @@ -2,13 +2,13 @@ ## Status and compatibility -As of this guide, the target Base-CLI release is `0.5.0`; the package is pre-1.0 +As of this guide, the target Base-CLI release is `0.5.1`; the package is pre-1.0 and classified as Beta. The demo tests the released `>=0.5.0,<0.6` line. This is not a promise that every future pre-1.0 minor line is compatible: Base-CLI's published policy treats patch releases as compatible and allows a minor release before 1.0 to be a compatibility boundary. Read the -[API stability policy](https://github.com/basefoundry/base-cli/blob/v0.5.0/docs/api-stability.md) -and [migration notes](https://github.com/basefoundry/base-cli/blob/v0.5.0/docs/migrations.md) +[API stability policy](https://github.com/basefoundry/base-cli/blob/v0.5.1/docs/api-stability.md) +and [migration notes](https://github.com/basefoundry/base-cli/blob/v0.5.1/docs/migrations.md) when changing the dependency range. The demo's lockfile records a reproducible resolved environment; readers moving to the 0.5 line should also read the [0.5 migration notes](https://github.com/basefoundry/base-cli/blob/main/docs/migration-0.5.md). @@ -63,7 +63,7 @@ does not follow a future 0.6 line automatically. | Base-CLI with Click or Typer | A shared lifecycle and documented automation/output boundary around a familiar parser. | One more dependency, an integration model to learn, and compatibility work as the framework evolves. | For the parser-focused comparison maintained by the framework project, see its -[framework choice guide](https://github.com/basefoundry/base-cli/blob/v0.5.0/docs/framework-choice.md). +[framework choice guide](https://github.com/basefoundry/base-cli/blob/v0.5.1/docs/framework-choice.md). For primary references, see the official [argparse documentation](https://docs.python.org/3/library/argparse.html), [Click documentation](https://click.palletsprojects.com/), and diff --git a/docs/use-in-your-project.md b/docs/use-in-your-project.md index e6231c1..a6bb46a 100644 --- a/docs/use-in-your-project.md +++ b/docs/use-in-your-project.md @@ -48,5 +48,5 @@ consumer-owned configuration, and structured output. The `App` and `attach` calls establish the framework boundary; the Click function remains your command. See the framework's [consumer quickstart](https://github.com/basefoundry/base-cli/blob/main/docs/consumer-quickstart.md) -and [API reference](https://github.com/basefoundry/base-cli/blob/v0.5.0/docs/api-reference.md) +and [API reference](https://github.com/basefoundry/base-cli/blob/v0.5.1/docs/api-reference.md) for the public interfaces. diff --git a/uv.lock b/uv.lock index 480bcc3..3a8bf06 100644 --- a/uv.lock +++ b/uv.lock @@ -22,14 +22,14 @@ wheels = [ [[package]] name = "base-cli" -version = "0.5.0" +version = "0.5.1" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "click" }, ] -sdist = { url = "https://files.pythonhosted.org/packages/59/65/bf7f021710d7c56321cafbadbfe5550aee7a4b917e010aa69abce470a2e5/base_cli-0.5.0.tar.gz", hash = "sha256:262b66a303f4ca821484e6a603c56379c26bf7f3526bc2cf1ae3b2c9a9027396", size = 411984, upload-time = "2026-10-10T01:20:39.682Z" } +sdist = { url = "https://files.pythonhosted.org/packages/0d/f6/d078286d45063e4dfcce7271a75b680df7565460ad78f64c2b97f3a4b437/base_cli-0.5.1.tar.gz", hash = "sha256:847ebf5bbc3dbe9286849cbf9d3819351757798dc46eebac55a967e16e763962", size = 415236, upload-time = "2026-10-10T08:09:18.532Z" } wheels = [ - { url = "https://files.pythonhosted.org/packages/cd/da/5144962d9f50943e367ef6afeb4938021868be1841a80af45c2ddfe3f186/base_cli-0.5.0-py3-none-any.whl", hash = "sha256:68ea16c38bc5bff49a328e2d03a6c2f2d182be1967a366f542c7092332da0d98", size = 144776, upload-time = "2026-10-10T01:20:38.314Z" }, + { url = "https://files.pythonhosted.org/packages/82/4d/42675ed3029b3dc66bcb1436f7a73fd4e4fd8b9d3bdf913273cb490b8edd/base_cli-0.5.1-py3-none-any.whl", hash = "sha256:541a0cce3b77a6c69265aaef5ede362807474c916502cce347caeb2f670b9767", size = 144686, upload-time = "2026-10-10T08:09:17.027Z" }, ] [package.optional-dependencies]