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: .github/ISSUE_TEMPLATE/release-checklist.md
+17-3Lines changed: 17 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,9 +16,8 @@ assignees: ''
16
16
17
17
**Before release**:
18
18
19
-
-[ ] Make sure the release branch (e.g., `3.1.x`) is up to date with any backports.
20
19
-[ ] Make sure that all pull requests which will be included in the release have been properly documented as changelog files in the [`changes/` directory](https://github.com/zarr-developers/zarr-python/tree/main/changes).
21
-
-[ ] Run ``towncrier build --version x.y.z`` to create the changelog, and commit the result to the release branch.
20
+
-[ ] Run ``towncrier build --version x.y.z`` to create the changelog, and commit the result to `main`.
22
21
-[ ] Check [SPEC 0](https://scientific-python.org/specs/spec-0000/#support-window) to see if the minimum supported version of Python or NumPy needs bumping.
23
22
-[ ] Check to ensure that:
24
23
-[ ] Deprecated workarounds/codes/tests are removed. Run `grep "# TODO" **/*.py` to find all potential TODOs.
@@ -42,7 +41,7 @@ assignees: ''
42
41
-[ ] Go to https://github.com/zarr-developers/zarr-python/releases.
43
42
-[ ] Click "Draft a new release".
44
43
-[ ] Choose a version number prefixed with a `v` (e.g. `v0.0.0`). For pre-releases, include the appropriate suffix (e.g. `v0.0.0a1` or `v0.0.0rc2`).
45
-
-[ ] Set the target branch to the release branch (e.g., `3.1.x`)
44
+
-[ ] Set the target to `main`.
46
45
-[ ] Set the description of the release to: `See release notes https://zarr.readthedocs.io/en/stable/release-notes.html#release-0-0-0`, replacing the correct version numbers. For pre-release versions, the URL should omit the pre-release suffix, e.g. "a1" or "rc1".
47
46
-[ ] Click on "Generate release notes" to auto-fill the description.
48
47
-[ ] Make a release by clicking the 'Publish Release' button, this will automatically create a tag too.
@@ -57,3 +56,18 @@ assignees: ''
57
56
---
58
57
59
58
-[ ] Party :tada:
59
+
60
+
---
61
+
62
+
<details>
63
+
<summary><strong>Releasing from a branch other than main</strong></summary>
64
+
65
+
In rare cases (e.g. patch releases for an older minor version), you may need to release from a dedicated release branch (e.g. `3.1.x`):
66
+
67
+
- Create the release branch from the appropriate tag if it doesn't already exist.
68
+
- Cherry-pick or backport the necessary commits onto the branch.
69
+
- Run `towncrier build --version x.y.z` and commit the result to the release branch instead of `main`.
70
+
- When drafting the GitHub Release, set the target to the release branch instead of `main`.
71
+
- After the release, ensure any relevant changelog updates are also reflected on `main`.
0 commit comments