Allow dev versions (#437)

Author: blink1073

.github/workflows/check-release.yml

@@ -22,5 +22,4 @@ jobs:
       - name: Check Release
         uses: ./.github/actions/check-release
         with:
-          version_spec: 10.10.10
           token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -139,7 +139,6 @@ jobs:
         uses: ./.github/actions/prep-release
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          version_spec: 10.10.10
           dry_run: true
 
       - name: populate-release

jupyter_releaser/__init__.py

@@ -1,3 +1,3 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
-__version__ = "1.0.0a4"
+__version__ = "1.0.0.dev0"

jupyter_releaser/changelog.py

@@ -192,9 +192,6 @@ def update_changelog(changelog_path, entry):
     changelog = insert_entry(changelog, entry, version=version)
     Path(changelog_path).write_text(changelog, encoding="utf-8")
 
-    # Stage changelog
-    util.run(f"git add {util.normalize_path(changelog_path)}")
-
 
 def insert_entry(changelog, entry, version=None):
     """Insert the entry into the existing changelog."""
@@ -349,7 +346,7 @@ def extract_current(changelog_path):
 def extract_current_version(changelog_path):
     """Extract the current released version from the changelog"""
     body = extract_current(changelog_path)
-    match = re.match(r"#+ ([\d.]+)", body.strip())
+    match = re.match(r"#+ (\d\S+)", body.strip())
     if not match:
         raise ValueError("Could not find previous version")
     return match.groups()[0]

jupyter_releaser/cli.py

@@ -57,7 +57,8 @@ def invoke(self, ctx):
 
         # Print a separation header
         util.log(f'\n\n{"-" * 50}')
-        util.log(f"\n{cmd_name}\n")
+        util.log(f"\n\n{cmd_name}\n\n")
+        util.log(f'\n\n{"-" * 50}')
 
         if cmd_name in skip or cmd_name.replace("-", "_") in skip:
             util.log("*** Skipping based on skip config")
@@ -74,7 +75,7 @@ def invoke(self, ctx):
                 value = os.environ[str(param.envvar)]
                 if "token" in name.lower():
                     value = "***"
-                util.log(f"Using env value for {name}: {value}")
+                util.log(f"Using env value for {name}: '{value}'")
                 continue
 
             # Handle cli and options overrides.
@@ -83,7 +84,9 @@ def invoke(self, ctx):
                 # Defer to cli overrides
                 if arg not in ctx.args:
                     val = options.get(name, options.get(name.replace("_", "-")))
-                    util.log(f"Adding option override for {arg}")
+                    if "token" in arg.lower():
+                        val = "***"
+                    util.log(f"Adding option override for {arg}: '{val}")
                     if isinstance(val, list):
                         for v in val:
                             ctx.args.append(arg)
@@ -93,12 +96,15 @@ def invoke(self, ctx):
                         ctx.args.append(val)
                     continue
                 else:
-                    util.log(f"Using cli arg for {name}")
+                    val = ctx.args[ctx.args.index(arg) + 1]
+                    if "token" in name.lower():
+                        val = "***"
+                    util.log(f"Using cli arg for {name}: '{val}'")
                     continue
 
-            util.log(f"Using default value for {name}")
+            util.log(f"Using default value for {name}: '{param.default}'")
 
-        util.log(f'{"-" * 50}\n\n')
+        util.log(f'{"~" * 50}\n\n')
 
         # Handle before hooks
         before = f"before-{cmd_name}"

jupyter_releaser/lib.py

@@ -76,14 +76,14 @@ def draft_changelog(
     current = changelog.extract_current(changelog_path)
     util.log(f"\n\nCurrent Changelog Entry:\n{current}")
 
-    # Check out any unstaged files from version bump
-    # If this is an automated changelog PR, there may be no effective changes
+    # Check out all changed files.
     try:
-        util.run("git checkout -- .")
+        util.run("git checkout .", echo=True)
     except CalledProcessError as e:
         util.log(str(e))
         return
 
+    util.run("git status", echo=True)
     util.log(f"\n\nCreating draft GitHub release for {version}")
     owner, repo_name = repo.split("/")
     gh = util.get_gh_object(dry_run=dry_run, owner=owner, repo=repo_name, token=auth)

jupyter_releaser/tests/test_functions.py

@@ -6,7 +6,6 @@
 import time
 from pathlib import Path
 
-import pytest
 import toml
 from ghapi.core import GhApi
 
@@ -298,12 +297,10 @@ def test_bump_version_dev(py_package):
     assert util.get_version() == "0.1.0.dev0"
     util.bump_version("dev")
     assert util.get_version() == "0.1.0.dev1"
-    with pytest.raises(ValueError):
-        util.bump_version("next")
-    with pytest.raises(ValueError):
-        util.bump_version("patch")
+    util.bump_version("next")
+    util.bump_version("patch")
     util.bump_version("minor")
-    assert util.get_version() == "0.1.0"
+    assert util.get_version() == "0.2.0"
 
 
 def test_get_config_python(py_package):

jupyter_releaser/util.py

@@ -63,7 +63,7 @@ def run(cmd, **kwargs):
     """Run a command as a subprocess and get the output as a string"""
     quiet_error = kwargs.pop("quiet_error", False)
     show_cwd = kwargs.pop("show_cwd", False)
-    quiet = kwargs.pop("quiet", False)
+    quiet = kwargs.get("quiet", False)
     echo = kwargs.pop("echo", False)
 
     if echo:
@@ -78,7 +78,6 @@ def run(cmd, **kwargs):
         # subprocess methods
         return _run_win(cmd, **kwargs)
 
-    quiet = kwargs.get("quiet")
     kwargs.setdefault("check", True)
 
     try:
@@ -281,28 +280,53 @@ def bump_version(version_spec, *, changelog_path="", version_cmd=""):
     # Add some convenience options on top of "tbump" and "hatch"
     if "tbump" in version_cmd or "hatch" in version_cmd:
         v = parse_version(get_version())
+        log(f"Current version was: {v}")
         assert isinstance(v, Version)
 
         if v.is_devrelease:
-            # bump from the version in the changelog.
+            # bump from the version in the changelog unless the spec is dev.
+            # Import here to avoid circular import.
+            from jupyter_releaser.changelog import extract_current_version
+
+            try:
+                vc = parse_version(extract_current_version(changelog_path))
+                log(f"Changelog version was: {vc}")
+                assert isinstance(vc, Version)
+            except ValueError:
+                vc = v
+
             if version_spec in ["patch", "next"]:
-                raise ValueError(
-                    "We do not support 'patch' or 'next' when dev versions are used, please use an explicit version."
-                )
+                if vc.is_prerelease:
+                    if vc.is_devrelease:
+                        # Bump to the next dev release.
+                        assert vc.dev is not None
+                        version_spec = f"{vc.major}.{vc.minor}.{vc.micro}{vc.dev}{vc.dev + 1}"
+                    else:
+                        assert vc.pre is not None
+                        # Bump to the next prerelease.
+                        version_spec = f"{vc.major}.{vc.minor}.{vc.micro}{vc.pre[0]}{vc.pre[1] + 1}"
 
-            # Drop the dev portion and move to the minor release.
+                else:
+                    # Bump to the next micro.
+                    version_spec = f"{vc.major}.{vc.minor}.{vc.micro + 1}"
+
+            # Move to the minor release
             elif version_spec == "minor":
-                version_spec = f"{v.major}.{v.minor}.{v.micro}"
+                version_spec = f"{vc.major}.{v.minor+1}.0"
 
             # Bump to the next dev version.
             elif version_spec == "dev":
                 assert v.dev is not None
                 version_spec = f"{v.major}.{v.minor}.{v.micro}.dev{v.dev + 1}"
 
         else:
-            # Bump to next minor for dev.
+            # Handle dev version spec.
             if version_spec == "dev":
-                version_spec = f"{v.major}.{v.minor + 1}.0.dev0"
+                if v.pre:
+                    version_spec = f"{v.major}.{v.minor}.{v.micro}.dev0"
+                # Bump to next minor dev.
+                else:
+                    version_spec = f"{v.major}.{v.minor + 1}.0.dev0"
 
             # For next, go to next prerelease or patch if it is a final version.
             elif version_spec == "next":
@@ -321,7 +345,7 @@ def bump_version(version_spec, *, changelog_path="", version_cmd=""):
                 version_spec = f"{v.major}.{v.minor + 1}.0"
 
     # Bump the version
-    run(f"{version_cmd} {version_spec}")
+    run(f"{version_cmd} {version_spec}", echo=True)
 
     return get_version()
 

pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["hatchling>=1.0"]
+requires = ["hatchling>=1.11"]
 build-backend = "hatchling.build"
 
 [project]
@@ -57,10 +57,14 @@ jupyter-releaser = "jupyter_releaser.cli:main"
 
 [tool.hatch.version]
 path = "jupyter_releaser/__init__.py"
+validate-bump = false
 
 [tool.jupyter-releaser.hooks]
 after-populate-release = "bash ./.github/scripts/bump_tag.sh"
 
+[tool.jupyter-releaser.options]
+post-version-spec = "dev"
+
 [tool.pytest.ini_options]
 addopts = "-raXs --durations 10 --color=yes --doctest-modules"
 testpaths = [