Merge pull request #100 from afshin/hook-handling

Fix up hook handling

Author: Steven Silvester

.github/actions/check-release/action.yml

@@ -47,4 +47,4 @@ runs:
         python -m jupyter_releaser.actions.draft_release
 
         # Publish Assets
-        jupyter-releaser publish-assets --use-checkout-dir
+        jupyter-releaser publish-assets

README.md

@@ -140,7 +140,7 @@ You can also define hooks to run before and after
 commands in a `hooks` section. Hooks can be a shell command to run or
 a list of shell commands, and are specified to run `before-` or `after-`
 a command.
-Note: the only invalid hook name is `before-prep-git`, since a checkout of the target repository is not yet available at that point.
+Note: the only unusable hook names are `before-prep-git` and `before-extract-release`, since a checkout of the target repository is not yet available at that point.
 
 ### Configuration File Priority
 

jupyter_releaser/cli.py

@@ -100,7 +100,8 @@ def invoke(self, ctx):
         # Handle after hooks
 
         # Re-read config if we just did a git checkout
-        if cmd_name == "prep-git":
+        if cmd_name in ["prep-git", "extract-release"]:
+            os.chdir(util.CHECKOUT_NAME)
             config = util.read_config()
             hooks = config.get("hooks", {})
 
@@ -456,6 +457,7 @@ def draft_release(
 @main.command()
 @add_options(auth_options)
 @click.argument("release-url", nargs=1)
+@use_checkout_dir()
 def delete_release(auth, release_url):
     """Delete a draft GitHub release by url to the release page"""
     lib.delete_release(auth, release_url)
@@ -487,18 +489,17 @@ def extract_release(auth, dist_dir, dry_run, release_url, npm_install_options):
     envvar="TWINE_COMMAND",
     default="twine upload",
 )
-@click.option("--use-checkout-dir", help="Use the checkout directory", is_flag=True)
 @add_options(dry_run_options)
-def publish_assets(dist_dir, npm_token, npm_cmd, twine_cmd, dry_run, use_checkout_dir):
+@use_checkout_dir()
+def publish_assets(dist_dir, npm_token, npm_cmd, twine_cmd, dry_run):
     """Publish release asset(s)"""
-    lib.publish_assets(
-        dist_dir, npm_token, npm_cmd, twine_cmd, dry_run, use_checkout_dir
-    )
+    lib.publish_assets(dist_dir, npm_token, npm_cmd, twine_cmd, dry_run)
 
 
 @main.command()
 @add_options(auth_options)
 @click.argument("release-url", nargs=1)
+@use_checkout_dir()
 def publish_release(auth, release_url):
     """Publish GitHub release"""
     lib.publish_release(auth, release_url)
@@ -510,14 +511,14 @@ def publish_release(auth, release_url):
 @add_options(username_options)
 @add_options(changelog_path_options)
 @add_options(dry_run_options)
-@add_options(git_url_options)
 @click.argument("release-url")
+@use_checkout_dir()
 def forwardport_changelog(
-    auth, ref, branch, repo, username, changelog_path, dry_run, git_url, release_url
+    auth, ref, branch, repo, username, changelog_path, dry_run, release_url
 ):
     """Forwardport Changelog Entries to the Default Branch"""
     lib.forwardport_changelog(
-        auth, ref, branch, repo, username, changelog_path, dry_run, git_url, release_url
+        auth, ref, branch, repo, username, changelog_path, dry_run, release_url
     )
 
 

jupyter_releaser/lib.py

@@ -77,11 +77,11 @@ def check_links(ignore_glob, ignore_links, cache_file, links_expire):
     for f in files:
         file_cmd = cmd + f' "{f}"'
         try:
-            util.run(file_cmd)
+            util.run(file_cmd, shell=False)
         except Exception as e:
             # Return code 5 means no tests were run (no links found)
             if e.returncode != 5:
-                util.run(file_cmd + " --lf")
+                util.run(file_cmd + " --lf", shell=False)
 
 
 def draft_changelog(version_spec, branch, repo, since, auth, changelog_path, dry_run):
@@ -272,8 +272,12 @@ def extract_release(auth, dist_dir, dry_run, release_url, npm_install_options):
     owner, repo = match["owner"], match["repo"]
     gh = GhApi(owner=owner, repo=repo, token=auth)
     release = util.release_for_url(gh, release_url)
+    branch = release.target_commitish
     assets = release.assets
 
+    # Prepare a git checkout
+    prep_git(None, branch, f"{owner}/{repo}", auth, None, None)
+
     # Clean the dist folder
     dist = Path(dist_dir)
     if dist.exists():
@@ -303,7 +307,6 @@ def extract_release(auth, dist_dir, dry_run, release_url, npm_install_options):
     if dry_run:
         return
 
-    branch = release.target_commitish
     tag_name = release.tag_name
 
     sha = None
@@ -313,17 +316,10 @@ def extract_release(auth, dist_dir, dry_run, release_url, npm_install_options):
     if sha is None:
         raise ValueError("Could not find tag")
 
-    # Run a git checkout
-    # Fetch the branch
-    # Get the commmit message for the branch
+    # Get the commmit message for the tag
     commit_message = ""
-    with TemporaryDirectory() as td:
-        url = gh.repos.get().html_url
-        util.run(f"git clone {url} local", cwd=td)
-        checkout = osp.join(td, "local")
-        if not osp.exists(url):
-            util.run(f"git fetch origin {branch}", cwd=checkout)
-        commit_message = util.run(f"git log --format=%B -n 1 {sha}", cwd=checkout)
+    checkout = osp.join(os.getcwd(), util.CHECKOUT_NAME)
+    commit_message = util.run(f"git log --format=%B -n 1 {sha}", cwd=checkout)
 
     for asset in assets:
         # Check the sha against the published sha
@@ -351,13 +347,8 @@ def parse_release_url(release_url):
     return match
 
 
-def publish_assets(dist_dir, npm_token, npm_cmd, twine_cmd, dry_run, use_checkout_dir):
+def publish_assets(dist_dir, npm_token, npm_cmd, twine_cmd, dry_run):
     """Publish release asset(s)"""
-    if use_checkout_dir:
-        if not osp.exists(util.CHECKOUT_NAME):
-            raise ValueError("Please run prep-git first")
-        os.chdir(util.CHECKOUT_NAME)
-
     if dry_run:
         # Start local pypi server with no auth, allowing overwrites,
         # in a temporary directory
@@ -424,14 +415,14 @@ def publish_release(auth, release_url):
     util.actions_output("release_url", release.html_url)
 
 
-def prep_git(ref, branch, repo, auth, username, url, install=True):
+def prep_git(ref, branch, repo, auth, username, url):
     """Set up git"""
     repo = repo or util.get_repo()
 
     user_name = ""
     try:
         user_name = util.run("git config --global user.email")
-    except Exception as e:
+    except Exception:
         pass
 
     if not user_name:
@@ -498,42 +489,42 @@ def prep_git(ref, branch, repo, auth, username, url, install=True):
         util.run(checkout_cmd)
 
     # Install the package
-    if install:
-        # install python package in editable mode with test deps
-        if util.SETUP_PY.exists():
-            util.run('pip install -q -e ".[test]"')
+    # install python package in editable mode with test deps
+    if util.SETUP_PY.exists():
+        util.run('pip install -q -e ".[test]"')
 
-        # prefer yarn if yarn lock exists
-        elif util.YARN_LOCK.exists():
-            if not shutil.which("yarn"):
-                util.run("npm install -g yarn")
-            util.run("yarn")
+    # prefer yarn if yarn lock exists
+    elif util.YARN_LOCK.exists():
+        if not shutil.which("yarn"):
+            util.run("npm install -g yarn")
+        util.run("yarn")
 
-        # npm install otherwise
-        elif util.PACKAGE_JSON.exists():
-            util.run("npm install")
+    # npm install otherwise
+    elif util.PACKAGE_JSON.exists():
+        util.run("npm install")
 
     os.chdir(orig_dir)
 
     return branch
 
 
 def forwardport_changelog(
-    auth, ref, branch, repo, username, changelog_path, dry_run, git_url, release_url
+    auth, ref, branch, repo, username, changelog_path, dry_run, release_url
 ):
     """Forwardport Changelog Entries to the Default Branch"""
     # Set up the git repo with the branch
     match = parse_release_url(release_url)
     gh = GhApi(owner=match["owner"], repo=match["repo"], token=auth)
     release = util.release_for_url(gh, release_url)
     tag = release.tag_name
+    source_branch = release.target_commitish
 
     repo = f'{match["owner"]}/{match["repo"]}'
 
-    # We want to target the main branch
-    orig_dir = os.getcwd()
-    branch = prep_git(None, None, repo, auth, username, git_url, install=False)
-    os.chdir(util.CHECKOUT_NAME)
+    # switch to main branch here
+    branch = branch or util.get_default_branch()
+    util.run(f"git fetch origin {branch}")
+    util.run(f"git checkout {branch}")
 
     # Bail if the tag has been merged to the branch
     tags = util.run(f"git --no-pager tag --merged {branch}", quiet=True)
@@ -594,5 +585,4 @@ def forwardport_changelog(
     )
 
     # Clean up after ourselves
-    os.chdir(orig_dir)
-    shutil.rmtree(util.CHECKOUT_NAME)
+    util.run(f"git checkout {source_branch}")

jupyter_releaser/tests/conftest.py

@@ -58,6 +58,9 @@ def git_repo(tmp_path):
     readme = tmp_path / "README.md"
     readme.write_text("Hello from foo project\n", encoding="utf-8")
 
+    config = Path(util.JUPYTER_RELEASER_CONFIG)
+    config.write_text(testutil.TOML_CONFIG, encoding="utf-8")
+
     run("git add .")
     run('git commit -m "foo"')
     run(f"git remote add origin {util.normalize_path(tmp_path)}")