Skip to content

Commit 4eda04e

Browse files
authored
Update CI & release checklist for release branch (#3312)
* Run CI on 3.1.x branch * Clarify releasing on a branch
1 parent 108ec58 commit 4eda04e

File tree

5 files changed

+14
-9
lines changed

5 files changed

+14
-9
lines changed

.github/ISSUE_TEMPLATE/release-checklist.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ assignees: ''
77

88
---
99

10-
**Release**: [v0.x.x](https://github.com/zarr-developers/zarr-python/milestones/?)
10+
**Release**: [v3.x.x](https://github.com/zarr-developers/zarr-python/milestones/?)
1111
**Scheduled Date**: 20YY/MM/DD
1212

1313
**Priority PRs/issues to complete prior to release**
@@ -16,8 +16,9 @@ assignees: ''
1616

1717
**Before release**:
1818

19+
- [ ] Make sure the release branch (e.g., `3.1.x`) is up to date with any backports.
1920
- [ ] 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).
20-
- [ ] Run ``towncrier build --version x.y.z`` to create the changelog, and commit the result to the main branch.
21+
- [ ] Run ``towncrier build --version x.y.z`` to create the changelog, and commit the result to the release branch.
2122
- [ ] 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.
2223
- [ ] Check to ensure that:
2324
- [ ] Deprecated workarounds/codes/tests are removed. Run `grep "# TODO" **/*.py` to find all potential TODOs.
@@ -41,6 +42,7 @@ assignees: ''
4142
- [ ] Go to https://github.com/zarr-developers/zarr-python/releases.
4243
- [ ] Click "Draft a new release".
4344
- [ ] 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`)
4446
- [ ] 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".
4547
- [ ] Click on "Generate release notes" to auto-fill the description.
4648
- [ ] Make a release by clicking the 'Publish Release' button, this will automatically create a tag too.

.github/workflows/gpu_test.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ name: GPU Test
55

66
on:
77
push:
8-
branches: [ main ]
8+
branches: [ main, 3.1.x ]
99
pull_request:
10-
branches: [ main ]
10+
branches: [ main, 3.1.x ]
1111
workflow_dispatch:
1212

1313
env:

.github/workflows/hypothesis.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
name: Slow Hypothesis CI
22
on:
33
push:
4-
branches: [main, 3.0.x]
4+
branches: [main, 3.1.x]
55
pull_request:
6-
branches: [main, 3.0.x]
6+
branches: [main, 3.1.x]
77
types: [opened, reopened, synchronize, labeled]
88
schedule:
99
- cron: "0 0 * * *" # Daily “At 00:00” UTC

.github/workflows/test.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ name: Test
55

66
on:
77
push:
8-
branches: [ main, 3.0.x ]
8+
branches: [ main, 3.1.x ]
99
pull_request:
10-
branches: [ main, 3.0.x ]
10+
branches: [ main, 3.1.x ]
1111
workflow_dispatch:
1212

1313
concurrency:

docs/developers/contributing.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -261,9 +261,12 @@ Pull requests submitted by an external contributor should be reviewed and approv
261261
one core developer before being merged. Ideally, pull requests submitted by a core developer
262262
should be reviewed and approved by at least one other core developer before being merged.
263263

264-
Pull requests should not be merged until all CI checks have passed (GitHub Actions
264+
Pull requests should not be merged until all CI checks have passed (GitHub Actions,
265265
Codecov) against code that has had the latest main merged in.
266266

267+
Before merging the milestone must be set either to decide whether a PR will be in the next
268+
patch, minor, or major release. The next section explains which types of changes go in each release.
269+
267270
Compatibility and versioning policies
268271
-------------------------------------
269272

0 commit comments

Comments
 (0)