Skip to content

Commit ade329d

Browse files
committed
docs: update CHANGELOG and CONTRIBUTING for v3.0.1 and hatch-vcs workflow
1 parent 59571a6 commit ade329d

2 files changed

Lines changed: 27 additions & 2 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,21 @@ All notable changes to this project are documented here. The format follows
44
[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project
55
adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7+
## [3.0.1] - 2026-08-04
8+
9+
### Fixed
10+
11+
- Project URLs pointed at the fork instead of `onyphe/pyonyphe`, so the PyPI
12+
page linked to the wrong repository. Same for the GHCR image label and the
13+
README badges and examples.
14+
15+
### Changed
16+
17+
- The version is now derived from the Git tag (`hatch-vcs`) instead of being
18+
hardcoded in `pyproject.toml`. Tagging `v3.1.0rc1` now really produces a
19+
`3.1.0rc1` pre-release; previously the tag name had no effect on the
20+
published version.
21+
722
## [3.0.0] - 2026-08-04
823

924
Full rewrite against the current ONYPHE APIv2.

‎CONTRIBUTING.md‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,17 @@ Never commit a real API key, not even in a fixture.
9191

9292
## Releasing
9393

94-
1. Update `CHANGELOG.md` and the `version` field in `pyproject.toml`.
95-
2. Tag: `git tag vX.Y.Z && git push --tags`.
94+
1. Update `CHANGELOG.md`.
95+
2. Tag: `git tag vX.Y.Z && git push upstream vX.Y.Z`.
9696
3. `release.yml` runs the tests, builds, and publishes to PyPI through trusted
9797
publishing (OIDC — no token stored in the repository).
98+
99+
The version is **not** written in `pyproject.toml`: `hatch-vcs` derives it from
100+
the tag. `v3.0.1` builds `3.0.1`, `v3.1.0rc1` builds a real pre-release. Two
101+
consequences worth remembering:
102+
103+
- Every `checkout` in the workflows uses `fetch-depth: 0`. A shallow clone has
104+
no tags, and the build would silently produce a bogus version.
105+
- The Docker build context excludes `.git`, so the version is injected through
106+
the `HATCH_VCS_PRETEND_VERSION` build argument. A local `docker build`
107+
without that argument produces `0.0.0.dev0`, which is expected.

0 commit comments

Comments
 (0)