From 7bec305b53467d1941f3a2b9300cbdcde1514ee4 Mon Sep 17 00:00:00 2001
From: Zeitsperre <10819524+Zeitsperre@users.noreply.github.com>
Date: Fri, 29 Dec 2023 12:07:19 -0500
Subject: [PATCH 1/8] fix semver workflow to conform to regex conventions in
 GitHub

---
 .github/workflows/bump-version.yml | 30 ++++++++++++++----------------
 1 file changed, 14 insertions(+), 16 deletions(-)

diff --git a/.github/workflows/bump-version.yml b/.github/workflows/bump-version.yml
index 17659bb83..b9bd0d62d 100644
--- a/.github/workflows/bump-version.yml
+++ b/.github/workflows/bump-version.yml
@@ -6,19 +6,18 @@ on:
       - master
     paths-ignore:
       - .*
-      - .github/**.yml
+      - .github/*/*.yml
       - CHANGES.rst
       - Makefile
-      - docs/**.ipynb
-      - docs/**.py
-      - docs/**.rst
+      - docs/*/*.ipynb
+      - docs/*/*.py
+      - docs/*/*.rst
       - docs/Makefile
       - docs/make.bat
       - docs/references.bib
       - environment.yml
       - pylintrc
       - pyproject.toml
-      - requirements_dev.txt
       - requirements_upstream.txt
       - tox.ini
       - xclim/__init__.py
@@ -46,20 +45,19 @@ jobs:
       - name: Install bump-my-version
         run: |
           python -m pip install bump-my-version
-      - name: Bump Patch Version
-        if: ${{ !env.CURRENT_VERSION =~ \d+\.\d+\.\d+(-dev(\.\d+)?)?$ }}
+      - name: Conditional Bump
+        id: bump
         run: |
-          echo "Version is stable, bumping 'patch' version"
-          bump-my-version bump patch
-          NEW_VERSION="$(grep -E '__version__'  xclim/__init__.py | cut -d ' ' -f3)"
-          echo "new_version=${NEW_VERSION}"
-      - name: Bump Build Version
-        if: ${{ env.CURRENT_VERSION =~ \d+\.\d+\.\d+(-dev(\.\d+)?)?$ }}
-        run: |
-          echo "Development version (ends in 'dev(\.\d+)?'), bumping 'build' version"
-          bump-my-version bump build
+          if [[ $CURRENT_VERSION =~ \d+\.\d+\.\d+(-dev(\.\d+)?)?$ ]]; then
+            echo "Development version (ends in 'dev(\.\d+)?'), bumping 'build' version"
+            bump-my-version bump build
+          else
+            echo "Version is stable, bumping 'patch' version"
+            bump-my-version bump patch
+          fi
           NEW_VERSION="$(grep -E '__version__'  xclim/__init__.py | cut -d ' ' -f3)"
           echo "new_version=${NEW_VERSION}"
+          echo "NEW_VERSION=${NEW_VERSION}" >> $GITHUB_ENV
       - name: Push Changes
         uses: ad-m/github-push-action@v0.8.0
         with:

From 1ed9e3d3aeb37ceb5fd2ac5ec8c9783e86ff941a Mon Sep 17 00:00:00 2001
From: Zeitsperre <10819524+Zeitsperre@users.noreply.github.com>
Date: Fri, 29 Dec 2023 13:11:43 -0500
Subject: [PATCH 2/8] update deployment information

---
 CONTRIBUTING.rst | 40 +++++++++++++++++-----------------------
 1 file changed, 17 insertions(+), 23 deletions(-)

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index e9ad5486c..fe75f7c8a 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -354,47 +354,41 @@ The method we use is as follows::
 
 **Patch** should be used for bug fixes and optimizations;
 
-**Release** is a keyword used to specify the degree of production readiness (`beta` [, and optionally, `gamma`]). *Only versions built from the main development branch will ever have this tag!*
+**Release** is a keyword used to specify the degree of production readiness (`dev` [, and optionally, `release`]). *Only versions built from the main development branch will ever have this marker!*
 
-  An increment to the Major or Minor will reset the Release to `beta`. When a build is promoted above `beta` (ie: release-ready), it's a good idea to push this version towards PyPi.
+**Build** is a keyword used to specify the build number. *Only versions built from the main development branch will ever have this number!*
 
-Deploying
----------
+An increment to the Major or Minor will reset the Release to `beta`. When a build is promoted above `beta` (ie: the release/stable version), it's a good idea to push this version towards PyPI.
 
-A reminder for the maintainers on how to prepare the library for a tagged version.
+Packaging and Deployment
+------------------------
 
-Make sure all your changes are committed (**including an entry in HISTORY.rst**).
-Then run::
+This section serves as a reminder for the maintainers on how to prepare the library for a tagged version and how to deploy packages to TestPyPI and PyPI.
 
-    $ bump2version <option>  # possible options: major / minor / patch / release
+When a new version has been minted (features have been successfully integrated test coverage and stability is adequate), maintainers should update the pip-installable package (wheel and source release) on PyPI as well as the binary on conda-forge.
+
+From a new branch (e.g. `prepare-v123`), open a Pull Request and make sure all your changes to support a new version are committed (**update the entry for newest version in CHANGES.rst**), Then run::
+
+    $ bump-my-version bump <option>  # possible options: major / minor / patch / release / build
 
 These commands will increment the version and create a commit with an autogenerated message.
 
-For PyPI releases/stable versions, ensure that the last version bumping command run is `$ bump2version release` to remove the `-dev`.
-These changes can now be merged to the main development branch::
+For PyPI releases/stable versions, ensure that the last version bumping command run is `$ bump-my-version bump release` to remove the `-dev`. These changes can now be merged to the `prepare-v123` branch::
 
-    $ git push
+    $ git push origin prepare-v123
 
-With this performed, we can tag a version that will act as the GitHub-provided stable source archive.
-Be sure to only tag from the `main` branch when all changes from PRs have been merged! Commands needed are::
+With this performed, we can tag a version that will act as the GitHub-provided stable source archive. **Be sure to only tag from the `main` branch when all changes from PRs have been merged!** The commands needed are::
 
-    $ git tag v1.2.3-XYZ
+    $ git tag v1.2.3
     $ git push --tags
 
 .. note::
-    Starting from October, 2021, all tags pushed to GitHub will trigger a build and publish a package to TestPyPI by default. TestPyPI is a testing ground that is not indexed or easily available to `pip`.
-    The test package can be found at `xclim on TestPyPI`_.
-
-Packaging
----------
-
-When a new version has been minted (features have been successfully integrated test coverage and stability is adequate),
-maintainers should update the pip-installable package (wheel and source release) on PyPI as well as the binary on conda-forge.
+    Starting from October, 2021, all tags pushed to GitHub will trigger a build and publish a package to TestPyPI by default. TestPyPI is a testing ground that is not indexed or easily available to `pip`. The test package can be found at `xclim on TestPyPI`_.
 
 The Automated Approach
 ~~~~~~~~~~~~~~~~~~~~~~
 
-The simplest way to package `xclim` is to "publish" a version on GitHuh. GitHub CI Actions are presently configured to build the library and publish the packages on PyPI automatically.
+The simplest way to package `xclim` is to "publish" a version on GitHub. GitHub CI Actions are presently configured to build the library and publish the packages on PyPI automatically.
 
 When publishing on GitHub, maintainers will need to generate the release notes for the current version, replacing the ``:issue:``, ``:pull:``, and ``:user:`` tags. The `xclim` CLI offers a helper function for performing this action::
 

From e32641a29baa87ba21c684fe287ff23fdcbbd8f6 Mon Sep 17 00:00:00 2001
From: Zeitsperre <10819524+Zeitsperre@users.noreply.github.com>
Date: Tue, 9 Jan 2024 13:20:23 -0500
Subject: [PATCH 3/8] no-verify commit args

---
 pyproject.toml | 1 +
 1 file changed, 1 insertion(+)

diff --git a/pyproject.toml b/pyproject.toml
index d9c54cbed..275c773b8 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -124,6 +124,7 @@ target-version = [
 [tool.bumpversion]
 current_version = "0.47.4-beta"
 commit = true
+commit_args = "--no-verify"
 tag = false
 allow_dirty = true
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\-(?P<release>[a-z]+)(\\.(?P<build>\\d+)))?"

From 2b865b7ef17b278e9a3573ab8dc1d10082eb4dae Mon Sep 17 00:00:00 2001
From: Zeitsperre <10819524+Zeitsperre@users.noreply.github.com>
Date: Tue, 9 Jan 2024 13:20:44 -0500
Subject: [PATCH 4/8] no longer allow-dirty

---
 pyproject.toml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/pyproject.toml b/pyproject.toml
index 275c773b8..82666c5ab 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -126,7 +126,7 @@ current_version = "0.47.4-beta"
 commit = true
 commit_args = "--no-verify"
 tag = false
-allow_dirty = true
+allow_dirty = false
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\-(?P<release>[a-z]+)(\\.(?P<build>\\d+)))?"
 serialize = [
   "{major}.{minor}.{patch}-{release}.{build}",

From a91e3e04f321a4303fcb365c0c339372f5628e88 Mon Sep 17 00:00:00 2001
From: Zeitsperre <10819524+Zeitsperre@users.noreply.github.com>
Date: Tue, 9 Jan 2024 13:22:22 -0500
Subject: [PATCH 5/8] manually change version to new system (0.47.4-dev.0)

---
 pyproject.toml    | 2 +-
 xclim/__init__.py | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/pyproject.toml b/pyproject.toml
index 82666c5ab..042b5e676 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -122,7 +122,7 @@ target-version = [
 ]
 
 [tool.bumpversion]
-current_version = "0.47.4-beta"
+current_version = "0.47.4-dev.0"
 commit = true
 commit_args = "--no-verify"
 tag = false
diff --git a/xclim/__init__.py b/xclim/__init__.py
index d56960211..84382db37 100644
--- a/xclim/__init__.py
+++ b/xclim/__init__.py
@@ -15,7 +15,7 @@
 
 __author__ = """Travis Logan"""
 __email__ = "logan.travis@ouranos.ca"
-__version__ = "0.47.4-beta"
+__version__ = "0.47.4-dev.0"
 
 
 _module_data = _files("xclim.data")

From 7cca819d89ea266995a2b314f97b0e9d8ccb2663 Mon Sep 17 00:00:00 2001
From: Zeitsperre <10819524+Zeitsperre@users.noreply.github.com>
Date: Tue, 9 Jan 2024 13:25:13 -0500
Subject: [PATCH 6/8] update CHANGES.rst

---
 CHANGES.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/CHANGES.rst b/CHANGES.rst
index deaabd36d..d43df5880 100644
--- a/CHANGES.rst
+++ b/CHANGES.rst
@@ -30,6 +30,7 @@ Internal changes
 * The `flake8` configuration has been migrated from `setup.cfg` to `.flake8`; `setup.cfg` has been removed. (:pull:`1569`)
 * The `bump-version.yml` workflow has been adjusted to bump the `patch` version when the last version is determined to have been a `release` version; otherwise, the `build` version is bumped. (:issue:`1557`, :pull:`1569`).
 * The GitHub Workflows now use the `step-security/harden-runner` action to monitor source code, actions, and dependency safety. All workflows now employ more constrained permissions rule sets to prevent security issues. (:pull:`1577`).
+* Updated the CONTRIBUTING.rst directions to showcase the new versioning system. (:issue:`1557`, :pull:`1573`).
 
 v0.47.0 (2023-12-01)
 --------------------

From 13c54b1422cba3d800bd2b73d28f1c2570251afb Mon Sep 17 00:00:00 2001
From: Zeitsperre <10819524+Zeitsperre@users.noreply.github.com>
Date: Tue, 9 Jan 2024 14:08:49 -0500
Subject: [PATCH 7/8] update tests to support new version string conventions

---
 tests/conftest.py        | 5 ++++-
 tests/test_formatting.py | 2 +-
 2 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/tests/conftest.py b/tests/conftest.py
index b3c7339ea..6d84c5d6b 100644
--- a/tests/conftest.py
+++ b/tests/conftest.py
@@ -27,7 +27,10 @@
 from xclim.testing.utils import get_file
 from xclim.testing.utils import open_dataset as _open_dataset
 
-if not __xclim_version__.endswith("-beta") and helpers.TESTDATA_BRANCH == "main":
+if (
+    re.match(r"^\d+\.\d+\.\d+$", __xclim_version__)
+    and helpers.TESTDATA_BRANCH == "main"
+):
     # This does not need to be emitted on GitHub Workflows and ReadTheDocs
     if not os.getenv("CI") and not os.getenv("READTHEDOCS"):
         warnings.warn(
diff --git a/tests/test_formatting.py b/tests/test_formatting.py
index 958240d49..438547cca 100644
--- a/tests/test_formatting.py
+++ b/tests/test_formatting.py
@@ -53,7 +53,7 @@ def func(da, arg1, arg2=None, arg3=None):
     out = func(atmosds.tas, 1, arg2=[1, 2], arg3=None)
 
     matches = re.match(
-        r"\[([0-9-:\s]*)\]\s(\w*):\s(\w*)\((.*)\)\s-\sxclim\sversion:\s(\d*\.\d*\.\d*[a-zA-Z-]*)",
+        r"\[([0-9-:\s]*)]\s(\w*):\s(\w*)\((.*)\)\s-\sxclim\sversion:\s(\d*\.\d*\.\d*[a-zA-Z-]*(\.\d*)?)",
         out.attrs["history"],
     ).groups()
 

From d184ec83fd90f6dd0c0c45691b4deaccb123fd9d Mon Sep 17 00:00:00 2001
From: Zeitsperre <10819524+Zeitsperre@users.noreply.github.com>
Date: Tue, 9 Jan 2024 14:22:57 -0500
Subject: [PATCH 8/8] fix regex

---
 .github/workflows/bump-version.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/bump-version.yml b/.github/workflows/bump-version.yml
index f51873561..99114674a 100644
--- a/.github/workflows/bump-version.yml
+++ b/.github/workflows/bump-version.yml
@@ -55,7 +55,7 @@ jobs:
       - name: Conditional Bump
         id: bump
         run: |
-          if [[ $CURRENT_VERSION =~ \d+\.\d+\.\d+(-dev(\.\d+)?)?$ ]]; then
+          if [[ $CURRENT_VERSION =~ \d+\.\d+\.\d+-dev(\.\d+)?$ ]]; then
             echo "Development version (ends in 'dev(\.\d+)?'), bumping 'build' version"
             bump-my-version bump build
           else