Skip to content

Commit f30e67f

Browse files
committed
Update guidance
1 parent 06acd08 commit f30e67f

2 files changed

Lines changed: 12 additions & 2 deletions

File tree

.github/ISSUE_TEMPLATE/release-checklist.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ assignees: ''
1818

1919
- [ ] 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.
2020
- [ ] Verify that the latest CI workflows on `main` are passing: [Tests](https://github.com/zarr-developers/zarr-python/actions/workflows/test.yml), [GPU Tests](https://github.com/zarr-developers/zarr-python/actions/workflows/gpu_test.yml), [Hypothesis](https://github.com/zarr-developers/zarr-python/actions/workflows/hypothesis.yaml), [Docs](https://github.com/zarr-developers/zarr-python/actions/workflows/docs.yml), [Lint](https://github.com/zarr-developers/zarr-python/actions/workflows/lint.yml), [Wheels](https://github.com/zarr-developers/zarr-python/actions/workflows/releases.yml).
21-
- [ ] Run the ["Downstream" workflow](https://github.com/zarr-developers/zarr-python/actions/workflows/downstream.yml) and verify Xarray and numcodecs tests pass.
22-
- [ ] Run the ["Prepare release" workflow](https://github.com/zarr-developers/zarr-python/actions/workflows/prepare_release.yml) with the target version. This will build the changelog and open a release PR.
21+
- [ ] Run the ["Prepare release" workflow](https://github.com/zarr-developers/zarr-python/actions/workflows/prepare_release.yml) with the target version. This will build the changelog and open a release PR with the `run-downstream` label.
22+
- [ ] Verify that the [downstream tests](https://github.com/zarr-developers/zarr-python/actions/workflows/downstream.yml) (triggered automatically by the `run-downstream` label) pass on the release PR.
2323
- [ ] Review the release PR and verify the changelog in `docs/release-notes.md` looks correct.
2424
- [ ] Merge the release PR.
2525

docs/contributing.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -316,6 +316,16 @@ If an existing Zarr format version changes, or a new version of the Zarr format
316316
Open an issue on GitHub announcing the release using the release checklist template:
317317
[https://github.com/zarr-developers/zarr-python/issues/new?template=release-checklist.md](https://github.com/zarr-developers/zarr-python/issues/new?template=release-checklist.md). The release checklist includes all steps necessary for the release.
318318

319+
### Preparing a release
320+
321+
Releases are prepared using the ["Prepare release notes"](https://github.com/zarr-developers/zarr-python/actions/workflows/prepare_release.yml) workflow. To run it:
322+
323+
1. Go to the [workflow page](https://github.com/zarr-developers/zarr-python/actions/workflows/prepare_release.yml) and click "Run workflow".
324+
2. Enter the release version (e.g. `3.2.0`) and the target branch (defaults to `main`).
325+
3. The workflow will run `towncrier build` to render the changelog, remove consumed fragments from `changes/`, and open a pull request on the `release/v<version>` branch.
326+
4. The release PR is automatically labeled `run-downstream`, which triggers the [downstream test workflow](https://github.com/zarr-developers/zarr-python/actions/workflows/downstream.yml) to run Xarray and numcodecs integration tests against the release branch.
327+
5. Review the rendered changelog in `docs/release-notes.md` and verify downstream tests pass before merging.
328+
319329
## Benchmarks
320330

321331
Zarr uses [pytest-benchmark](https://pytest-benchmark.readthedocs.io/en/latest/) for running

0 commit comments

Comments
 (0)