precommit

.github/workflows/create_publish_pr.yaml

@@ -45,7 +45,7 @@ jobs:
           git config --global user.name 'aicsgithub'
           git config --global user.email '[email protected]'
           python scripts/publish_bumpver_handler.py ${{ inputs.semver_component }}
-      
+
       # takes the commit from the last step, pushes to new branch, release, and creates PR
       - name: Create pull request
         uses: peter-evans/create-pull-request@v6
@@ -54,11 +54,9 @@ jobs:
           base: main
           title: Bump version and publish
           body: See commit message or diff for new version number
-      
+
       - name: Tag version
         run: |
           git checkout workflow-release
           python scripts/tag_with_current_version.py
           git push origin --tags
-
-      

pyproject.toml

@@ -149,4 +149,4 @@ push            = false
 [tool.bumpver.file_patterns]
 "pyproject.toml" = ['current_version = "{version}"', 'version = "{version}"']
 "version.toml" = ['version = "{version}"']
-"cyto_dl/__init__.py" = ['__version__ = "{version}"']
+"cyto_dl/__init__.py" = ['__version__ = "{version}"']

scripts/publish_bumpver_handler.py

@@ -1,9 +1,50 @@
 # this file is intended to be called by a github workflow (.github/workflows/publish_to_pypi.yaml)
 # it makes decisions based on the current version and the component specified for bumping,
 # which the workflow cannot do
+
+"""
+TESTING:
+- add and commit any changes (keep track of this commit hash)
+- bumpver update --set-version 1.0.0
+
+- python publish_bumpver_handler.py
+  - expect: ValueError
+
+- python publish_bumpver_handler.py fake
+  - expect: ValueError
+
+- python publish_bumpver_handler.py major
+  - expect: version updated to 2.0.0
+
+- python publish_bumpver_handler.py minor
+  - expect: version updated to 2.1.0
+
+- python publish_bumpver_handler.py patch
+  - expect: version updated to 2.1.1
+
+- python publish_bumpver_handler.py dev
+  - expect: version updated to 2.1.2.dev0
+
+- python publish_bumpver_handler.py dev
+  - expect: version updated to 2.1.2.dev1
+
+- python publish_bumpver_handler.py major
+  - expect: ValueError
+
+- python publish_bumpver_handler.py minor
+  - expect: ValueError
+
+- python publish_bumpver_handler.py patch
+  - expect: version updated to 2.1.2
+
+- git reset --hard {hash of the commit made at the beginning}
+- git tag --delete 1.0.0 2.0.0 2.1.0 2.1.1 2.1.2 2.1.2.dev0 2.1.2.dev1
+"""
+
 import subprocess
 import sys
-from typing import Set, List
+from typing import List, Set
+
 import toml
 
 
@@ -25,79 +66,28 @@ def main():
     if len(version_components) == 4:
         if component == "dev":
             # increment the dev tag (e.g. 1.0.0.dev0 -> 1.0.0.dev1)
-            update_output = subprocess.run(
-                ["bumpver", "update", "--tag-num", "-n"]
-            )
+            update_output = subprocess.run(["bumpver", "update", "--tag-num", "-n"])
         elif component == "patch":
             # finalize the patch by removing dev tag (e.g. 1.0.0.dev1 -> 1.0.0)
-            update_output = subprocess.run(
-                ["bumpver", "update", "--tag=final", "-n"]
-            )
+            update_output = subprocess.run(["bumpver", "update", "--tag=final", "-n"])
         else:
-            raise ValueError(
-                "Cannot update major or minor version while dev version is current"
-            )
+            raise ValueError("Cannot update major or minor version while dev version is current")
 
     elif len(version_components) == 3:
         if component == "dev":
             # increment patch and begin at dev0 (e.g. 1.0.0 -> 1.0.1.dev0)
-            update_output = subprocess.run(
-                ["bumpver", "update", "--patch", "--tag=dev", "-n"]
-            )
+            update_output = subprocess.run(["bumpver", "update", "--patch", "--tag=dev", "-n"])
         else:
-            update_output = subprocess.run(
-                ["bumpver", "update", f"--{component}", "-n"]
-            )
+            update_output = subprocess.run(["bumpver", "update", f"--{component}", "-n"])
 
     else:
         raise ValueError(
             f"Unknown version format: {version}. Expected MAJOR.MINOR.PATCH[.PYTAGNUM]"
         )
 
     if update_output.returncode != 0:
-        raise RuntimeError(
-            f"bumpver exited with code {update_output.returncode}"
-        )
+        raise RuntimeError(f"bumpver exited with code {update_output.returncode}")
 
 
 if __name__ == "__main__":
     main()
-
-"""
-TESTING:
-- add and commit any changes (keep track of this commit hash)
-- bumpver update --set-version 1.0.0
-
-- python publish_bumpver_handler.py
-  - expect: ValueError
-
-- python publish_bumpver_handler.py fake
-  - expect: ValueError
-
-- python publish_bumpver_handler.py major
-  - expect: version updated to 2.0.0
-
-- python publish_bumpver_handler.py minor
-  - expect: version updated to 2.1.0
-
-- python publish_bumpver_handler.py patch
-  - expect: version updated to 2.1.1
-
-- python publish_bumpver_handler.py dev
-  - expect: version updated to 2.1.2.dev0
-
-- python publish_bumpver_handler.py dev
-  - expect: version updated to 2.1.2.dev1
-
-- python publish_bumpver_handler.py major
-  - expect: ValueError
-
-- python publish_bumpver_handler.py minor
-  - expect: ValueError
-
-- python publish_bumpver_handler.py patch
-  - expect: version updated to 2.1.2
-
-- git reset --hard {hash of the commit made at the beginning}
-- git tag --delete 1.0.0 2.0.0 2.1.0 2.1.1 2.1.2 2.1.2.dev0 2.1.2.dev1
-"""

scripts/tag_with_current_version.py

@@ -1,16 +1,15 @@
 # This file is intended to be called by a github workflow
 import subprocess
+
 import toml
 
 
 def main():
     version: str = toml.load("pyproject.toml")["project"]["version"]
-    tag_output: subprocess.CompletedProcess = subprocess.run(
-        ["git", "tag", f"v{version}"]
-    )
+    tag_output: subprocess.CompletedProcess = subprocess.run(["git", "tag", f"v{version}"])
     if tag_output.returncode != 0:
         raise RuntimeError("failed to tag")
 
 
 if __name__ == "__main__":
-    main()
+    main()

version.toml

@@ -1,4 +1,4 @@
 # -----DO NOT MODIFY THIS FILE-----
 # This file should only be modified by bumpver, which should in turn only be ran
 # via a GH Action
-version = "0.1.7"
+version = "0.1.7"