diff --git a/CHANGELOG.md b/CHANGELOG.md index ac16155..8b57a02 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,10 +7,9 @@ All notable changes to Tool-Semantics will be documented in this file. ### Added - (none yet) -## [0.2.0] — Unreleased +## [0.2.0] — 2026-08-10 -The release artifacts and GitHub release tag have not yet been published. Until -then, install directly from the repository as documented in the README. +First PyPI release. Install with `pip install tool-semantics`. ### Added - `tool.output_schema_added` / `removed` / `changed` detection (#8) diff --git a/README.md b/README.md index 1280e38..dc6d6e8 100644 --- a/README.md +++ b/README.md @@ -105,10 +105,8 @@ Result: breaking ## Install (library) ```bash -# The first PyPI release is not published yet. -# Install from this repository for now: -pip install "tool-semantics @ git+https://github.com/askmy-stack/tool-semantics.git" -# or, for local development: pip install -e . +pip install tool-semantics +# or from source: pip install -e . ``` ```python diff --git a/docs/github-action.md b/docs/github-action.md index 12e426c..e1076d1 100644 --- a/docs/github-action.md +++ b/docs/github-action.md @@ -12,9 +12,9 @@ askmy-stack/tool-semantics/.github/actions/compare ## Versioning the Action Pin the composite Action to a **release tag** (or commit SHA) so consumer CI stays -reproducible. The Action has not been released under a version tag yet, so the -example below pins the current stable commit. After the first release, use the -matching version tag (`vX.Y.Z`); a floating major pin (`@v0`) can follow. +reproducible. Tags follow the package version (`v0.2.0`, …). A floating major pin +such as `@v0` is fine once a `v0` moving tag exists; prefer an exact tag for +production workflows. `@main` tracks the tip of the default branch and **may break** without notice — use it only for local experiments. @@ -41,10 +41,10 @@ jobs: - uses: actions/checkout@v4 - name: Capture baseline and candidate run: | - pip install "tool-semantics @ git+https://github.com/askmy-stack/tool-semantics.git@64befaa9f65f825d75c6ce088d1f40e35054fdf0" + pip install "tool-semantics==0.2.0" tool-semantics capture manifests/baseline.json -o .tool-semantics/baseline.json tool-semantics capture manifests/candidate.json -o .tool-semantics/candidate.json - - uses: askmy-stack/tool-semantics/.github/actions/compare@64befaa9f65f825d75c6ce088d1f40e35054fdf0 + - uses: askmy-stack/tool-semantics/.github/actions/compare@v0.2.0 with: baseline: .tool-semantics/baseline.json candidate: .tool-semantics/candidate.json diff --git a/docs/publishing.md b/docs/publishing.md index 92b78c6..f3752a0 100644 --- a/docs/publishing.md +++ b/docs/publishing.md @@ -1,9 +1,8 @@ # Publishing -Tool-Semantics will be published to PyPI from GitHub Releases using -[trusted publishing](https://docs.pypi.org/trusted-publishers/) (OIDC), after the -one-time PyPI configuration below is complete. No long-lived PyPI API token is -stored in the repository. +Tool-Semantics is published to PyPI from GitHub Releases using +[trusted publishing](https://docs.pypi.org/trusted-publishers/) (OIDC). +No long-lived PyPI API token is stored in the repository. ## One-time PyPI setup