Skip to content

Commit

Permalink
Switch to CalVer (calendar versioning) (#233)
Browse files Browse the repository at this point in the history
  • Loading branch information
GenevieveBuckley committed May 24, 2021
1 parent bbe73c6 commit 414b7c6
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/release/release_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,14 @@ to add it as a secret.
Determining the new version number
----------------------------------

We use `semantic versioning <https://medium.com/the-non-traditional-developer/semantic-versioning-for-dummies-45c7fe04a1f8>`_
We use `calendar versioning (CalVer) <https://calver.org/>`_
for `dask-image`. This means version numbers have the format
`Major.Minor.Patch`.
`YY.MM.DD`.

`Versioneer <https://github.com/warner/python-versioneer>`_
then determines the exact version from the latest
`git tag <https://git-scm.com/book/en/v2/Git-Basics-Tagging>`_
beginning with `v`.
beginning with `v`. So our git tags will have the format `vYY.MM.DD`.


Generate the release notes
Expand Down Expand Up @@ -88,7 +88,7 @@ including all changes since the last tagged release.

.. code-block:: bash
python docs/release/generate_release_notes.py v0.14.0 main --version 0.15.0
python docs/release/generate_release_notes.py v21.05.24 main --version 21.06.03
See help for this script with:
Expand Down Expand Up @@ -116,7 +116,7 @@ Go to the dask-image releases page: https://github.com/dask/dask-image/releases

Click the "Draft Release" button to create a new release candidate.

- Both the tag version and release title should have the format ``vX.Y.Zrc1``.
- Both the tag version and release title should have the format ``vYY.MM.DDrc1``.
- Copy-paste the release notes from ``HISTORY.rst`` for this release into the
description text box.

Expand All @@ -142,7 +142,7 @@ in order to isolate dependencies.

If the release candidate is not what you want, make your changes and
repeat the process from the beginning but
incrementing the number after ``rc`` (e.g. ``vX.Y.Zrc2``).
incrementing the number after ``rc`` (e.g. ``vYY.MM.DDrc1``).

Once you are satisfied with the release candidate it is time to generate
the actual release.
Expand Down

0 comments on commit 414b7c6

Please sign in to comment.