From bc13b7f93a353d936c196053757ec05ab282cf0b Mon Sep 17 00:00:00 2001 From: Josh Moore Date: Thu, 22 Sep 2022 11:38:12 +0200 Subject: [PATCH] Prepare 2.13.0 release (#1133) * Prepare 2.13.0 release * Update release instructions for pre-releases * Add #1142 for Greg's work * Make python-version match for pre-commits --- .github/workflows/Pre-commit-hooks.yml | 2 ++ .pre-commit-config.yaml | 4 ++-- docs/contributing.rst | 18 +++++++++++++----- docs/release.rst | 8 +++++--- 4 files changed, 22 insertions(+), 10 deletions(-) diff --git a/.github/workflows/Pre-commit-hooks.yml b/.github/workflows/Pre-commit-hooks.yml index 7955cb239a..0e51c184fb 100644 --- a/.github/workflows/Pre-commit-hooks.yml +++ b/.github/workflows/Pre-commit-hooks.yml @@ -23,6 +23,8 @@ jobs: - uses: actions/checkout@v3 #setting up Python v3.0.0 - uses: actions/setup-python@v3.0.0 + with: + python-version: '3.9' #using pre-commit latest i.e v2.0.3 - uses: pre-commit/action@v2.0.3 #Running pre-commit for all files diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 69828ad50d..70ead97d0b 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,6 +1,6 @@ default_stages: [commit, push] default_language_version: - python: python3.8 + python: python3.9 repos: - repo: https://github.com/PyCQA/flake8 rev: 3.8.2 @@ -14,4 +14,4 @@ repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v2.3.0 hooks: - - id: check-yaml \ No newline at end of file + - id: check-yaml diff --git a/docs/contributing.rst b/docs/contributing.rst index f7b4831089..0b3c56bc01 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -344,14 +344,22 @@ included in the release have been properly documented in To make a new release, go to https://github.com/zarr-developers/zarr-python/releases and click "Draft a new release". Choose a version number prefixed -with a `v` (e.g. `v0.0.0`) and set the description to: +with a `v` (e.g. `v0.0.0`). For pre-releases, include the +appropriate suffix (e.g. `v0.0.0a1` or `v0.0.0rc2`). -``` -See release notes https://zarr.readthedocs.io/en/stable/release.html#release-0-0-0 -``` + +Set the description of the release to:: + + See release notes https://zarr.readthedocs.io/en/stable/release.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". -Be sure to review and merge the https://github.com/conda-forge/zarr-feedstock +After creating the release, the documentation will be built on +https://readthedocs.io. Full releases will be available under +`/stable `_ while +pre-releases will be available under +`/latest `_. + +Also review and merge the https://github.com/conda-forge/zarr-feedstock pull request that will be automatically generated. diff --git a/docs/release.rst b/docs/release.rst index b79341df52..e963b5b509 100644 --- a/docs/release.rst +++ b/docs/release.rst @@ -15,8 +15,10 @@ Release notes 2.13.0 ------ -.. warning:: - Pre-release! Use :command:`pip install --pre zarr` to evaluate this release. + +.. + # .. warning:: + # Pre-release! Use :command:`pip install --pre zarr` to evaluate this release. Major changes ~~~~~~~~~~~~~ @@ -35,7 +37,7 @@ Major changes * **Zarr v3: add support for the default root path** rather than requiring that all API users pass an explicit path. - By :user:`Gregory R. Lee ` :issue:`1085`. + By :user:`Gregory R. Lee ` :issue:`1085`, :issue:`1142`. Bug fixes