diff --git a/docs/release/release_guide.rst b/docs/release/release_guide.rst index f97dea89..f19ccf5a 100644 --- a/docs/release/release_guide.rst +++ b/docs/release/release_guide.rst @@ -36,14 +36,14 @@ to add it as a secret. Determining the new version number ---------------------------------- -We use `semantic versioning `_ +We use `calendar versioning (CalVer) `_ for `dask-image`. This means version numbers have the format -`Major.Minor.Patch`. +`YY.MM.DD`. `Versioneer `_ then determines the exact version from the latest `git tag `_ -beginning with `v`. +beginning with `v`. So our git tags will have the format `vYY.MM.DD`. Generate the release notes @@ -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: @@ -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. @@ -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.