`bump-version` step is failing in Check Release workflows

[dlqqq]

Description

The bump-version step is failing.

Since the exception was being raised by hatch based on the stacktrace, I checked every single dependency of hatch to find what went wrong.

My best guess is that the virtualenv==20.35.0 release, published 1 hour ago, is causing this step to fail:

https://pypi.org/project/virtualenv/#history

Reproduce

https://github.com/jupyter-ai-contrib/jupyter-ai-chat-commands/actions/runs/18358692000/job/52297130859?pr=1

Environment `default` is incompatible: 'NoneType' object has no attribute 'get'
Traceback (most recent call last):
  File "/opt/hostedtoolcache/Python/3.12.11/x64/bin/jupyter-releaser", line 7, in <module>
    sys.exit(main())
             ^^^^^^
  File "/opt/hostedtoolcache/Python/3.12.11/x64/lib/python3.12/site-packages/click/core.py", line 1161, in __call__
    return self.main(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/hostedtoolcache/Python/3.12.11/x64/lib/python3.12/site-packages/click/core.py", line 1082, in main
    rv = self.invoke(ctx)
         ^^^^^^^^^^^^^^^^
  File "/home/runner/work/_actions/jupyter-server/jupyter_releaser/v2/jupyter_releaser/cli.py", line 121, in invoke
    super().invoke(ctx)
  File "/opt/hostedtoolcache/Python/3.12.11/x64/lib/python3.12/site-packages/click/core.py", line 1697, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/hostedtoolcache/Python/3.12.11/x64/lib/python3.12/site-packages/click/core.py", line 1443, in invoke
    return ctx.invoke(self.callback, **ctx.params)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/hostedtoolcache/Python/3.12.11/x64/lib/python3.12/site-packages/click/core.py", line 788, in invoke
    return __callback(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/runner/work/_actions/jupyter-server/jupyter_releaser/v2/jupyter_releaser/cli.py", line 385, in bump_version
    lib.bump_version(
  File "/home/runner/work/_actions/jupyter-server/jupyter_releaser/v2/jupyter_releaser/lib.py", line 28, in bump_version
    util.bump_version(version_spec, version_cmd=version_cmd, changelog_path=changelog_path)
  File "/home/runner/work/_actions/jupyter-server/jupyter_releaser/v2/jupyter_releaser/util.py", line 283, in bump_version
    v = parse_version(get_version())
                      ^^^^^^^^^^^^^
  File "/home/runner/work/_actions/jupyter-server/jupyter_releaser/v2/jupyter_releaser/util.py", line 175, in get_version
    return run(cmd).split("\n")[-1]
           ^^^^^^^^
  File "/home/runner/work/_actions/jupyter-server/jupyter_releaser/v2/jupyter_releaser/util.py", line 94, in run
    raise e
  File "/home/runner/work/_actions/jupyter-server/jupyter_releaser/v2/jupyter_releaser/util.py", line 86, in run
    process = tee(cmd, **kwargs)
              ^^^^^^^^^^^^^^^^^^
  File "/home/runner/work/_actions/jupyter-server/jupyter_releaser/v2/jupyter_releaser/tee.py", line 159, in run
    raise subprocess.CalledProcessError(
subprocess.CalledProcessError: Command 'hatch version' returned non-zero exit status 1.
Traceback (most recent call last):
  File "<frozen runpy>", line 198, in _run_module_as_main
  File "<frozen runpy>", line 88, in _run_code
  File "/home/runner/work/_actions/jupyter-server/jupyter_releaser/v2/jupyter_releaser/actions/prep_release.py", line 25, in <module>
    run_action("jupyter-releaser bump-version")
  File "/home/runner/work/_actions/jupyter-server/jupyter_releaser/v2/jupyter_releaser/actions/common.py", line 25, in run_action
    _run(target, *args, **kwargs)
  File "/home/runner/work/_actions/jupyter-server/jupyter_releaser/v2/jupyter_releaser/util.py", line 94, in run
    raise e
  File "/home/runner/work/_actions/jupyter-server/jupyter_releaser/v2/jupyter_releaser/util.py", line 86, in run
    process = tee(cmd, **kwargs)
              ^^^^^^^^^^^^^^^^^^
  File "/home/runner/work/_actions/jupyter-server/jupyter_releaser/v2/jupyter_releaser/tee.py", line 159, in run
    raise subprocess.CalledProcessError(
subprocess.CalledProcessError: Command 'jupyter-releaser bump-version' returned non-zero exit status 1.

[dlqqq]

Opened a test PR with no code changes to verify that something upstream is causing this:

jupyter-ai-contrib/jupyter-ai-chat-commands#2

Check release passed on the branch base main a few days ago, but is failing now on this PR with zero code changes.

[dlqqq]

Yup, an upstream issue was just opened:

pypa/virtualenv#2972

However, for some reason I can't find a workaround for this. I tried defining virtualenv!=20.35.0 in the build dependencies to no success. I also tried reinstalling virtualenv in version-cmd to no success either.

[dlqqq]

Found a workaround! Add this to pyproject.toml:

[tool.jupyter-releaser.hooks]
before-bump-version = ["pip install hatch virtualenv!=20.35.0"]

jupyter_releaser uses pipx run hatch version to get the version in the bump-version step, but will use the hatch installed in the environment if it is provided. So we can install hatch ourselves with a constraint on the virtualenv version to fix this issue. 🎉

Source: jupyter_releaser/util.py

def _get_hatch_version_cmd():
    if shutil.which("hatch"):
        return "hatch version"
    return "pipx run hatch version"