Merge pull request #6544 from blink1073/use-hatch-version

jtpio · web-flow · commit 73646334817f · 2022-09-26T15:24:46.000+02:00
Switch to hatch for python version
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
diff --git a/.github/workflows/buildutils.yml b/.github/workflows/buildutils.yml
@@ -37,12 +37,7 @@ jobs:
 
     - name: Reset version
       run: |
-        # TODO: improve this with a mock package?
-        # This step is to ensure the workflow always starts with a final version
-        sed -i -E 's/= VersionInfo\(.*\)/= VersionInfo\(9, 8, 7, "final", 0\)/' notebook/_version.py
-        cat notebook/_version.py
-        sed -i -E 's/current_version = .*/current_version = 9, 8, 7, "final", 0/' .bumpversion.cfg
-        cat .bumpversion.cfg
+        hatch version 9.8.7
         jlpm run lerna version 9.8.7 --no-push --force-publish --no-git-tag-version --yes
         git commit -am "Release 9.8.7"
 
diff --git a/buildutils/src/release-bump.ts b/buildutils/src/release-bump.ts
@@ -51,9 +51,6 @@ commander
     if (options.indexOf(spec) === -1) {
       throw new Error(`Version spec must be one of: ${options}`);
     }
-    if (isFinal && spec === 'release') {
-      throw new Error('Use "major" or "minor" to switch back to alpha release');
-    }
     if (isFinal && spec === 'build') {
       throw new Error('Cannot increment a build on a final release');
     }
@@ -63,15 +60,14 @@ commander
 
     // Handle dry runs.
     if (opts.dryRun) {
-      utils.run(`bumpversion --dry-run --verbose ${spec}`);
       return;
     }
 
     // If this is a major release during the alpha cycle, bump
     // just the Python version.
     if (prev.indexOf('a') !== -1 && spec === 'major') {
       // Bump the version.
-      utils.run(`bumpversion ${spec}`);
+      utils.run(`hatch version ${spec}`);
 
       // Run the post-bump script.
       postbump(commit);
@@ -113,7 +109,27 @@ commander
     }
 
     // Bump the version.
-    utils.run(`bumpversion ${spec} --allow-dirty`);
+    let pySpec = spec;
+    if (spec == 'release') {
+      if (prev.indexOf('a') !== -1) {
+        pySpec = 'beta';
+      } else if (prev.indexOf('b') !== -1) {
+        pySpec = 'rc';
+      } else if (prev.indexOf('rc') !== -1) {
+        pySpec = 'patch';
+      } else {
+        pySpec = 'alpha';
+      }
+    } else if (spec == 'build') {
+      if (prev.indexOf('a') !== -1) {
+        pySpec = 'a';
+      } else if (prev.indexOf('b') !== -1) {
+        pySpec = 'b';
+      } else if (prev.indexOf('rc') !== -1) {
+        pySpec = 'rc';
+      }
+    }
+    utils.run(`hatch version ${pySpec}`);
 
     // Run the post-bump script.
     postbump(commit);
diff --git a/buildutils/src/release-patch.ts b/buildutils/src/release-patch.ts
@@ -33,10 +33,7 @@ commander
     utils.prebump();
 
     // Patch the python version
-    utils.run('bumpversion patch'); // switches to alpha
-    utils.run('bumpversion release --allow-dirty'); // switches to beta
-    utils.run('bumpversion release --allow-dirty'); // switches to rc.
-    utils.run('bumpversion release --allow-dirty'); // switches to final.
+    utils.run('hatch version patch');
 
     // Version the changed
     let cmd =
diff --git a/buildutils/src/utils.ts b/buildutils/src/utils.ts
@@ -4,7 +4,7 @@ import { run } from '@jupyterlab/buildutils';
  * Get the current version of notebook
  */
 export function getPythonVersion(): string {
-  const cmd = 'hatchling version';
+  const cmd = 'hatch version';
   const lines = run(cmd, { stdio: 'pipe' }, true).split('\n');
   return lines[lines.length - 1];
 }
diff --git a/notebook/_version.py b/notebook/_version.py
@@ -1,22 +1,38 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
-
+import re
 from collections import namedtuple
 
-VersionInfo = namedtuple("VersionInfo", ["major", "minor", "micro", "releaselevel", "serial"])
+# Use "hatch version xx.yy.zz" to handle version changes
+__version__ = "7.0.0a5"
 
-# DO NOT EDIT THIS DIRECTLY!  It is managed by bumpversion
-version_info = VersionInfo(7, 0, 0, "alpha", 5)
+# PEP440 version parser
+_version_regex = re.compile(
+    r"""
+  (?P<major>\d+)
+  \.
+  (?P<minor>\d+)
+  \.
+  (?P<micro>\d+)
+  (?P<releaselevel>((a|b|rc|\.dev)))?
+  (?P<serial>\d+)?
+  """,
+    re.VERBOSE,
+)
 
-_specifier_ = {"alpha": "a", "beta": "b", "candidate": "rc", "final": ""}
+_version_fields = _version_regex.match(__version__).groupdict()  # type:ignore
+
+VersionInfo = namedtuple("VersionInfo", ["major", "minor", "micro", "releaselevel", "serial"])
 
-__version__ = "{}.{}.{}{}".format(
-    version_info.major,
-    version_info.minor,
-    version_info.micro,
-    (
-        ""
-        if version_info.releaselevel == "final"
-        else _specifier_[version_info.releaselevel] + str(version_info.serial)
-    ),
+version_info = VersionInfo(
+    *[
+        field
+        for field in (
+            int(_version_fields["major"]),
+            int(_version_fields["minor"]),
+            int(_version_fields["micro"]),
+            _version_fields["releaselevel"] or "",
+            _version_fields["serial"] or "",
+        )
+    ]
 )
diff --git a/package.json b/package.json
@@ -70,7 +70,7 @@
       "before-build-python": [
         "jlpm clean"
       ],
-      "before-bump-version": "python -m pip install bump2version"
+      "before-bump-version": "python -m pip install hatch"
     },
     "options": {
       "version-cmd": [
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,5 +1,5 @@
 [build-system]
-requires = ["hatchling>=1.0", "jupyterlab>=4.0.0a25,<5", "ypy-websocket==0.2"]
+requires = ["hatchling>=1.5", "jupyterlab>=4.0.0a25,<5", "ypy-websocket==0.2"]
 build-backend = "hatchling.build"
 
 [project]
@@ -62,13 +62,11 @@ test = [
 ]
 dev = [
     "pre-commit",
-    "bump2version",
-    "hatchling"
+    "hatch"
 ]
 
 [tool.hatch.version]
 path = "notebook/_version.py"
-source = "code"
 
 [tool.hatch.build.targets.wheel.shared-data]
 "notebook/labextension" = "share/jupyter/labextensions/@jupyter-notebook/lab-extension"

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ import { run } from '@jupyterlab/buildutils';`
`4`	`4`	`* Get the current version of notebook`
`5`	`5`	`*/`
`6`	`6`	`export function getPythonVersion(): string {`
`7`		`- const cmd = 'hatchling version';`
	`7`	`+ const cmd = 'hatch version';`
`8`	`8`	`const lines = run(cmd, { stdio: 'pipe' }, true).split('\n');`
`9`	`9`	`return lines[lines.length - 1];`
`10`	`10`	`}`