You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: templates/commands/release.md
+31-3Lines changed: 31 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -382,7 +382,33 @@ When running **Create Release** via `workflow_dispatch`, set `release_version` t
382
382
`{NEXT_VERSION}` (or `v{NEXT_VERSION}`) so the workflow publishes the intended tag
383
383
instead of auto-incrementing from the latest existing tag.
384
384
385
-
### 10. Clean Slate Preparation
385
+
### 10. Update Public-Facing Version References
386
+
387
+
After bumping `pyproject.toml` (Step 9), update **all** public documents that mention the current release version so they stay in sync. **Skip if DRY_RUN** — but list the files that would change.
388
+
389
+
#### A. Roadmap files
390
+
391
+
Update **both** roadmap files to reflect the new current release:
392
+
393
+
| File | Field to update |
394
+
|------|-----------------|
395
+
|`README.md` → `## 🗺️ Roadmap`|`### Current Release (v{NEXT_VERSION})` — add any new capabilities to the checked list |
396
+
|`/.documentation/roadmap.md`|`## Current Release: v{NEXT_VERSION}` — move newly shipped items from Near-Term into Current, update version example |
397
+
398
+
Ensure future roadmap section version ranges (`Near-Term`, `Medium-Term`, `Long-Term`) are **ahead** of `{NEXT_VERSION}`. If any future section uses a version number ≤ `{NEXT_VERSION}`, bump it forward.
399
+
400
+
#### B. Release notes / index page
401
+
402
+
| File | Field to update |
403
+
|------|-----------------|
404
+
|`release_notes.md`| Update highlights and "What's New" to `{NEXT_VERSION}`|
405
+
|`/.documentation/index.md`| Update any version badges or "latest" references |
406
+
407
+
#### C. Verify — no stale version strings
408
+
409
+
Run a quick search for the **old** version string (`{CURRENT_VERSION}`) across `README.md`, `release_notes.md`, `.documentation/*.md`, and confirm every remaining reference is intentional (e.g., CHANGELOG history). Flag any stale occurrences for manual review.
410
+
411
+
### 11. Clean Slate Preparation
386
412
387
413
After archival (skip if DRY_RUN):
388
414
@@ -405,7 +431,7 @@ For each quickfix in QUICKFIXES:
405
431
1. Create `/.documentation/specs/.gitkeep` if directory is empty
406
432
2. Create `/.documentation/quickfixes/.gitkeep` if directory is empty
407
433
408
-
### 11. Output Summary
434
+
### 12. Output Summary
409
435
410
436
#### Dry Run Output
411
437
@@ -471,7 +497,9 @@ To execute this release:
471
497
472
498
1. Confirm `pyproject.toml` has been bumped to `{NEXT_VERSION}` (Step 9A above).
473
499
474
-
2. Review generated documentation:
500
+
2. Confirm roadmap and public docs reference `{NEXT_VERSION}` (Step 10 above).
0 commit comments