Use version-agnostic examples in release docs.
Replace hardcoded semver examples with stable placeholders and point readers to pyproject.toml for the current version. Co-authored-by: Cursor <[email protected]>
This commit is contained in:
co-authored by
Cursor
parent
7dbb1fc8ab
commit
d3cbb65bbc
@@ -2,9 +2,11 @@
|
||||
|
||||
If this PR changes files under `python_repositories/`, the **title must** start with one of:
|
||||
|
||||
- `[patch]` or `[fix]` — bug fix (0.3.1 → 0.3.2)
|
||||
- `[minor]` or `[feat]` — new feature (0.3.1 → 0.4.0)
|
||||
- `[major]` or `[breaking]` — breaking change (0.3.1 → 1.0.0)
|
||||
- `[patch]` or `[fix]` — bug fix (`1.2.3` → `1.2.4`)
|
||||
- `[minor]` or `[feat]` — new feature (`1.2.3` → `1.3.0`)
|
||||
- `[major]` or `[breaking]` — breaking change (`1.2.3` → `2.0.0`)
|
||||
|
||||
Current version: see [`pyproject.toml`](pyproject.toml) on `main`.
|
||||
|
||||
Docs-, CI-, or test-only PRs do not need a prefix.
|
||||
|
||||
|
||||
@@ -173,9 +173,9 @@ Docs-, CI-, and test-only PRs do not need a prefix and will not trigger a releas
|
||||
|
||||
| Prefix | Bump | Example |
|
||||
| ------------------------- | ---------- | --------------------- |
|
||||
| `[patch]` or `[fix]` | patch | `0.3.1` → `0.3.2` |
|
||||
| `[minor]` or `[feat]` | minor | `0.3.1` → `0.4.0` |
|
||||
| `[major]` or `[breaking]` | major | `0.3.1` → `1.0.0` |
|
||||
| `[patch]` or `[fix]` | patch | `1.2.3` → `1.2.4` |
|
||||
| `[minor]` or `[feat]` | minor | `1.2.3` → `1.3.0` |
|
||||
| `[major]` or `[breaking]` | major | `1.2.3` → `2.0.0` |
|
||||
| _(none)_ | no release | docs / CI / deps only |
|
||||
|
||||
Example titles:
|
||||
@@ -189,4 +189,4 @@ Release notes are generated from commits since the previous tag (see [`scripts/c
|
||||
|
||||
### Manual release
|
||||
|
||||
You can still push a `v*.*.*` tag manually; `publish.yml` will build and publish. The current baseline version is **0.3.1**.
|
||||
You can still push a `v*.*.*` tag manually; `publish.yml` will build and publish. The current released version is in [`pyproject.toml`](pyproject.toml) (and on the latest `v*.*.*` tag).
|
||||
|
||||
Reference in New Issue
Block a user