Skip to content

Commit 84940bb

Browse files
committed
docs(release): update workflow and clarify dep-update step
1 parent e23edff commit 84940bb

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

docs/developer_guide/release.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ flowchart TD
2222
QAP -->|Yes| D["Build docs: just docs"]:::setup
2323
D --> E[Commit changes & push branch]:::git
2424
E --> F{Release type?}:::decision
25-
F -->|RC| RC1["just bump-rc-preview<br/>then just bump-rc"]:::setup
26-
F -->|Stable| ST1["just bump-preview<br/>then just bump"]:::setup
25+
F -->|RC| RC1["just bump-rc-preview<br/>then just bump-rc<br/><i>(append --increment MAJOR<br/>if not auto-detected)</i>"]:::setup
26+
F -->|Stable| ST1["just bump-preview<br/>then just bump<br/><i>(append --increment MAJOR<br/>if not auto-detected)</i>"]:::setup
2727
RC1 --> RC2["git push --follow-tags<br/>(pushes vX.Y.ZrcN)"]:::git
2828
RC2 --> RC3[CI: publish-testpypi.yml]:::ci
2929
RC3 --> RC4[TestPyPI + GitHub pre-release]:::rc
@@ -68,9 +68,9 @@ Only **bug fixes and documentation changes** belong on the release branch. New f
6868
```
6969

7070
```{warning}
71-
If you update any dependencies (e.g. to resolve security findings), regenerate the lock file immediately:
71+
If you update any dependencies (e.g. to resolve security findings), upgrade the specific package (this also rewrites `poetry.lock`):
7272
73-
poetry update <package>
73+
poetry update <package> # no just recipe: targets a single package
7474
7575
Then verify the change does not break any tests.
7676
```
@@ -167,20 +167,20 @@ Always run `--dry-run` first and review the proposed version and CHANGELOG entri
167167

168168
The following Commitizen settings in `pyproject.toml` shape this behaviour:
169169

170-
| Setting | Value | Effect |
171-
| --- | --- | --- |
172-
| `prerelease_offset` | `1` | Prereleases start at `rc1` (not the default `rc0`) |
170+
| Setting | Value | Effect |
171+
| ---------------------------- | ------ | --------------------------------------------------------------------------------------------- |
172+
| `prerelease_offset` | `1` | Prereleases start at `rc1` (not the default `rc0`) |
173173
| `changelog_merge_prerelease` | `true` | On the stable bump, all `rcN` CHANGELOG sections are rolled up into a single `vX.Y.Z` section |
174-
| `update_changelog_on_bump` | `true` | `CHANGELOG.md` is regenerated automatically on every bump |
174+
| `update_changelog_on_bump` | `true` | `CHANGELOG.md` is regenerated automatically on every bump |
175175

176176
The bump commands are wrapped in `just` recipes so the correct Commitizen flags are applied consistently:
177177

178-
| Recipe | Wraps | Use for |
179-
| --- | --- | --- |
180-
| `just bump-rc-preview` | `cz bump --prerelease rc --dry-run` | Preview an RC bump |
181-
| `just bump-rc` | `cz bump --prerelease rc` | Apply an RC bump |
182-
| `just bump-preview` | `cz bump --dry-run` | Preview a stable bump |
183-
| `just bump` | `cz bump` | Apply a stable bump |
178+
| Recipe | Wraps | Use for |
179+
| ---------------------- | ----------------------------------- | --------------------- |
180+
| `just bump-rc-preview` | `cz bump --prerelease rc --dry-run` | Preview an RC bump |
181+
| `just bump-rc` | `cz bump --prerelease rc` | Apply an RC bump |
182+
| `just bump-preview` | `cz bump --dry-run` | Preview a stable bump |
183+
| `just bump` | `cz bump` | Apply a stable bump |
184184

185185
Each recipe forwards extra arguments to Commitizen, so flags such as `--increment MAJOR` can be appended directly (e.g. `just bump-rc-preview --increment MAJOR`).
186186

0 commit comments

Comments
 (0)