From 90cec198aed62e82874452d02081a9579862a288 Mon Sep 17 00:00:00 2001
From: Genevieve Buckley <30920819+GenevieveBuckley@users.noreply.github.com>
Date: Fri, 28 May 2021 17:25:09 +1000
Subject: [PATCH] Update release guide, Dask CalVer uses YYYY.MM.DD (#236)
Dask calendar versioning uses the format `YYYY.MM.DD` (and not `YY.MM.DD`)
---
docs/release/release_guide.rst | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/docs/release/release_guide.rst b/docs/release/release_guide.rst
index f19ccf5a..27fbbc02 100644
--- a/docs/release/release_guide.rst
+++ b/docs/release/release_guide.rst
@@ -38,12 +38,12 @@ Determining the new version number
We use `calendar versioning (CalVer) `_
for `dask-image`. This means version numbers have the format
-`YY.MM.DD`.
+`YYYY.MM.DD`.
`Versioneer `_
then determines the exact version from the latest
`git tag `_
-beginning with `v`. So our git tags will have the format `vYY.MM.DD`.
+beginning with `v`. So our git tags will have the format `vYYYY.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 v21.05.24 main --version 21.06.03
+ python docs/release/generate_release_notes.py v2021.05.24 main --version 2021.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 ``vYY.MM.DDrc1``.
+- Both the tag version and release title should have the format ``vYYYY.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. ``vYY.MM.DDrc1``).
+incrementing the number after ``rc`` (e.g. ``vYYYY.MM.DDrc1``).
Once you are satisfied with the release candidate it is time to generate
the actual release.