@@ -251,14 +251,11 @@ See the `towncrier`_ docs for more.
251251
252252.. _towncrier : https://towncrier.readthedocs.io/en/stable/tutorial.html
253253
254- Development best practices, policies and procedures
255- ---------------------------------------------------
256-
257254The following information is mainly for core developers, but may also be of interest to
258255contributors.
259256
260257Merging pull requests
261- ~~~~~~~~~~~~~~~~~~~~~
258+ ---------------------
262259
263260Pull requests submitted by an external contributor should be reviewed and approved by at least
264261one core developer before being merged. Ideally, pull requests submitted by a core developer
@@ -268,10 +265,10 @@ Pull requests should not be merged until all CI checks have passed (GitHub Actio
268265Codecov) against code that has had the latest main merged in.
269266
270267Compatibility and versioning policies
271- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
268+ -------------------------------------
272269
273270Versioning
274- """"""""""
271+ ~~~~~~~~~~
275272Versions of this library are identified by a triplet of integers with the form
276273``<major>.<minor>.<patch> ``, for example ``3.0.4 ``. A release of ``zarr-python `` is associated with a new
277274version identifier. That new identifier is generated by incrementing exactly one of the components of
@@ -323,7 +320,7 @@ backwards-compatible changes wherever possible. When a backwards-incompatible ch
323320users should be notified well in advance, e.g. via informative deprecation warnings.
324321
325322Data format compatibility
326- ^^^^^^^^^^^^^^^^^^^^^^^^^
323+ """""""""""""""""""""""""
327324
328325The Zarr library is an implementation of a file format standard defined externally --
329326see the `Zarr specifications website <https://zarr-specs.readthedocs.io >`_ for the list of
@@ -340,36 +337,28 @@ breaking changes may be more frequent than usual.
340337
341338
342339Release procedure
343- ~~~~~~~~~~~~~~~~~
344-
345- .. note ::
346-
347- Most of the release process is now handled by GitHub workflow which should
348- automatically push a release to PyPI if a tag is pushed.
340+ -----------------
349341
350342Pre-release
351- """""""""""
343+ ~~~~~~~~~~~
3523441. Make sure that all pull requests which will be included in the release
353- have been properly documented as changelog files in :file: `changes `.
354- 2. Run ``towncrier build --version x.y.z `` to create the changelog.
345+ have been properly documented as changelog files in the :file: `changes/ ` directory.
346+ 2. Run ``towncrier build --version x.y.z `` to create the changelog, and commit the result
347+ to the main branch.
355348
356349Releasing
357- """""""""
358- To make a new release, go to
359- https://github.com/zarr-developers/zarr-python/releases and
360- click "Draft a new release". Choose a version number prefixed
361- with a `v ` (e.g. `v0.0.0 `). For pre-releases, include the
362- appropriate suffix (e.g. `v0.0.0a1 ` or `v0.0.0rc2 `).
363-
364-
365- Set the description of the release to::
350+ ~~~~~~~~~
351+ 1. Go to https://github.com/zarr-developers/zarr-python/releases
352+ 2. Click "Draft a new release".
353+ 3. Choose a version number prefixed with a `v ` (e.g. `v0.0.0 `).
354+ For pre-releases, include the appropriate suffix (e.g. `v0.0.0a1 ` or `v0.0.0rc2 `).
355+ 4. Set the description of the release to::
366356
367357 See release notes https://zarr.readthedocs.io/en/stable/release-notes.html#release-0-0-0
368358
369- replacing the correct version numbers. For pre-release versions,
370- the URL should omit the pre-release suffix, e.g. "a1" or "rc1".
371-
372- Click on "Generate release notes" to auto-file the description.
359+ replacing the correct version numbers. For pre-release versions,
360+ the URL should omit the pre-release suffix, e.g. "a1" or "rc1".
361+ 5. Click on "Generate release notes" to auto-fill the description.
373362
374363After creating the release, the documentation will be built on
375364https://readthedocs.io. Full releases will be available under
@@ -378,9 +367,8 @@ pre-releases will be available under
378367`/latest <https://zarr.readthedocs.io/en/latest >`_.
379368
380369Post-release
381- """"""""""""
370+ ~~~~~~~~~~~~
382371
383372- Review and merge the pull request on the
384373 `conda-forge feedstock <https://github.com/conda-forge/zarr-feedstock >`_ that will be
385374 automatically generated.
386- - Create a new "Unreleased" section in the release notes
0 commit comments