Skip to content

Commit b9754d8

Browse files
docs(release): document automated patch-release cron and support window
Address review feedback from lexfrei on docs/release.md: the Patch Releases section described only the manual process, so add an "Automated Patch Releases" subsection covering the nightly cron, the new-commits trigger, the 2-newest-lines support window, and the manual tag-push escape hatch for EOL lines. Assisted-By: Claude <[email protected]> Signed-off-by: Myasnikov Daniil <[email protected]>
1 parent fe99f97 commit b9754d8

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

‎docs/release.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,3 +164,17 @@ gitGraph
164164
1. Moves the tag `v0.42.1` to the newly created merge commit by force-pushing a tag to GitHub.
165165
2. Publishes the release page (`draft` → `latest`).
166166
7. The maintainer can now announce the release to the community.
167+
168+
### Automated Patch Releases
169+
170+
The manual steps above (steps 2–7) are normally kicked off for you by the **Auto Patch Release** workflow ([`.github/workflows/auto-release.yaml`](../.github/workflows/auto-release.yaml)), which runs on a nightly cron (`0 1 * * *`, ~02:00 CET) and can also be triggered manually via `workflow_dispatch`.
171+
172+
On each run it:
173+
174+
1. Lists every `release-X.Y` branch and keeps only the **2 newest minor lines** (e.g. once `release-1.5` exists the window is `{1.5, 1.4}` and older lines retire automatically). Older lines are treated as EOL and skipped — this avoids stray patch tags and broken release PRs on long-unmaintained branches.
175+
2. For each supported line, finds the latest published `vX.Y.Z` release and checks whether the branch has new commits after that release's commit.
176+
3. If there are new commits, it tags the branch `HEAD` as the next patch (`vX.Y.Z+1`) and pushes the tag. That tag push enters the same release pipeline as a manual patch tag (step 3 onward).
177+
178+
If nothing changed on a branch since its last release, no tag is cut.
179+
180+
**Cutting a patch on an EOL line.** The window only governs *automatic* tagging. A maintainer can still release any branch manually by pushing a `vX.Y.Z` tag — [`.github/workflows/tags.yaml`](../.github/workflows/tags.yaml) fires on any `v*.*.*` tag push, so the full release pipeline runs regardless of whether the line is inside the auto-release window.

0 commit comments

Comments
 (0)