Fix handling of ensure sha (#435)

Author: blink1073

jupyter_releaser/actions/populate_release.py

@@ -5,13 +5,7 @@
 import sys
 
 from jupyter_releaser.actions.common import run_action, setup
-from jupyter_releaser.util import (
-    actions_output,
-    ensure_sha,
-    get_gh_object,
-    log,
-    release_for_url,
-)
+from jupyter_releaser.util import actions_output, get_gh_object, log, release_for_url
 
 setup()
 
@@ -33,11 +27,7 @@
     raise RuntimeError("Cannot complete Draft Release, no draft GitHub release url found!")
 
 run_action("jupyter-releaser prep-git")
-
-if not dry_run:
-    # Ensure the branch sha has not changed.
-    ensure_sha()
-
+run_action("jupyter-releaser ensure-sha")
 run_action("jupyter-releaser bump-version")
 run_action("jupyter-releaser extract-changelog")
 
@@ -48,7 +38,5 @@
 run_action("jupyter-releaser build-python")
 run_action("jupyter-releaser check-python")
 run_action("jupyter-releaser tag-release")
-
-if not dry_run:
-    ensure_sha()
+run_action("jupyter-releaser ensure-sha")
 run_action("jupyter-releaser populate-release")

jupyter_releaser/cli.py

@@ -643,6 +643,17 @@ def publish_release(auth, dry_run, release_url):
     lib.publish_release(auth, dry_run, release_url)
 
 
+@main.command()
+@add_options(branch_options)
+@add_options(dry_run_options)
+@click.option(
+    "--expected-sha", help="The expected sha of the branch HEAD", envvar="RH_EXPECTED_SHA"
+)
+@use_checkout_dir()
+def ensure_sha(ref, branch, repo, dry_run, expected_sha):
+    util.ensure_sha(dry_run, expected_sha, branch)
+
+
 @main.command()
 @add_options(auth_options)
 @add_options(branch_options)

jupyter_releaser/lib.py

@@ -98,7 +98,7 @@ def draft_changelog(
         version=version,
         post_version_spec=post_version_spec,
         post_version_message=post_version_message,
-        current_sha=current_sha,
+        expected_sha=current_sha,
     )
     with tempfile.TemporaryDirectory() as d:
         metadata_path = Path(d) / util.METADATA_JSON
@@ -225,7 +225,6 @@ def populate_release(
     remote_name = util.get_remote_name(dry_run)
     remote_url = util.run(f"git config --get remote.{remote_name}.url")
     if not os.path.exists(remote_url):
-        util.ensure_sha()
         util.run(f"git push {remote_name} HEAD:{branch} --follow-tags --tags")
 
     # Set the body of the release with the changelog contents.

jupyter_releaser/tests/test_cli.py

@@ -147,6 +147,7 @@ def test_list_envvars(runner):
 check-imports: RH_CHECK_IMPORTS
 dist-dir: RH_DIST_DIR
 dry-run: RH_DRY_RUN
+expected-sha: RH_EXPECTED_SHA
 npm-cmd: RH_NPM_COMMAND
 npm-install-options: RH_NPM_INSTALL_OPTIONS
 npm-registry: NPM_REGISTRY
@@ -808,3 +809,13 @@ def test_forwardport_changelog_has_new(npm_package, runner, mocker, mock_github,
 ## 1.0.1
 """
     assert expected in text, text
+
+
+def test_ensure_sha(npm_package, runner, git_prep):
+    sha = util.run("git rev-parse HEAD", cwd=util.CHECKOUT_NAME)
+    current = util.run("git branch --show-current", cwd=util.CHECKOUT_NAME)
+    runner(["ensure-sha", "--branch", current, "--expected-sha", sha])
+    runner(["ensure-sha", "--branch", current, "--expected-sha", "abc", "--dry-run"])
+
+    with pytest.raises(RuntimeError):
+        runner(["ensure-sha", "--branch", current, "--expected-sha", "abc"])

jupyter_releaser/util.py

@@ -614,17 +614,19 @@ def handle_since():
     return since
 
 
-def ensure_sha():
+def ensure_sha(dry_run, expected_sha, branch):
     """Ensure the sha of the remote branch matches the expected sha"""
-    current_sha = os.environ["RH_CURRENT_SHA"]
-    branch = os.environ["RH_BRANCH"]
     log("Ensuring sha...")
     remote_name = get_remote_name(False)
     run("git remote -v", echo=True)
     run(f"git fetch {remote_name} {branch}", echo=True)
     sha = run(f"git rev-parse {remote_name}/{branch}", echo=True)
-    if sha != current_sha:
-        raise RuntimeError(f"{branch} current sha {sha} is not equal to expected sha {current_sha}")
+    if sha != expected_sha:
+        msg = f"{branch} current sha {sha} is not equal to expected sha {expected_sha}"
+        if dry_run:
+            log(msg)
+        else:
+            raise RuntimeError(msg)
 
 
 def get_gh_object(dry_run=False, **kwargs):