Allow version bumping tool to bump supported client (#343)

Author: stephen-riggs

.bumpclient.toml

@@ -0,0 +1,9 @@
+[tool.bumpversion]
+current_version = "0.13.1"
+commit = true
+tag = false
+
+[[tool.bumpversion.files]]
+filename = "src/murfey/__init__.py"
+search = '__supported_client_version__ = "{current_version}"'
+replace = '__supported_client_version__ = "{new_version}"'

.bumpversion.cfg

@@ -0,0 +1,14 @@
+[tool.bumpversion]
+current_version = "0.13.1"
+commit = true
+tag = true
+
+[[tool.bumpversion.files]]
+filename = "src/murfey/__init__.py"
+search = '__version__ = "{current_version}"'
+replace = '__version__ = "{new_version}"'
+
+[[tool.bumpversion.files]]
+filename = "pyproject.toml"
+search = 'version = "{current_version}"'
+replace = 'version = "{new_version}"'

.bumpversion.toml

@@ -4,14 +4,24 @@ on:
   workflow_dispatch:
     inputs:
       bumpLevel:
-        description: "Kind of version bump"
+        description: "Kind of version bump for project"
         required: true
         default: "patch"
         type: choice
         options:
           - major
           - minor
           - patch
+          - client
+        bumpClient:
+          description: "Bump supported client?"
+          required: true
+          type: boolean
+        newClientVersion:
+          description: "Version of new client (needed to bump supported client)"
+          required: true
+          default: "0.0.0"
+          type: string
 
 permissions:
   contents: read
@@ -45,13 +55,23 @@ jobs:
 
           echo "##[section]Creating commit on branch 'version-bump'"
           git checkout -b version-bump
-          bump2version ${{ inputs.bumpLevel }}
+
+          if [ ${{ inputs.clientBump } = true && ${{ inputs.newClientVersion }} != "0.0.0" ]; then
+            bump-my-version bump --config-file .bumpclient.toml --new-version ${{ inputs.newClientVersion }}
+          fi
+
+          if [&& ${{ inputs.bumpLevel }} != "client" ]
+            bump-my-version bump ${{ inputs.bumpLevel }}
+          fi
 
           echo "##[section]Creating pull request"
           git push -f --set-upstream origin version-bump
           gh pr create -B main -H version-bump -t "Version update (${{ inputs.bumpLevel }})" -b "
           This is an automated pull request to update the version.
 
+          Bumped supported client client version: ${{ inputs.bumpClient }}
+          If true, the supported client version is now: ${{ inputs.newClientVersion }}
+
           After merging this, the \`Publish version\` action will tag this release and publish to pypi.
           "
           echo

.github/workflows/version-bump.yml

@@ -47,7 +47,7 @@ client = [
     "xmltodict",
 ]
 developer = [
-    "bump2version", # Version control
+    "bump-my-version<0.11.0", # Version control
     "ipykernel", # Enable interactive coding with VS Code and Jupyter Notebook
     "pre-commit", # Formatting, linting, type checking, etc.
     "pytest", # Test code functionality