Merge pull request #115 from fcollonval/ft/set-commit-message

Allow to set commit message

Author: Steven Silvester

jupyter_releaser/cli.py

@@ -402,15 +402,27 @@ def check_links(ignore_glob, ignore_links, cache_file, links_expire):
 
 @main.command()
 @add_options(dist_dir_options)
+@click.option(
+    "--release-message",
+    envvar="RH_RELEASE_MESSAGE",
+    default="Publish {version}",
+    help="The message to use for the release commit",
+)
+@click.option(
+    "--tag-message",
+    envvar="RH_TAG_MESSAGE",
+    default="Release {tag_name}",
+    help="The message to use for the release tag",
+)
 @click.option(
     "--no-git-tag-workspace",
     is_flag=True,
     help="Whether to skip tagging npm workspace packages",
 )
 @use_checkout_dir()
-def tag_release(dist_dir, no_git_tag_workspace):
+def tag_release(dist_dir, release_message, tag_message, no_git_tag_workspace):
     """Create release commit and tag"""
-    lib.tag_release(dist_dir, no_git_tag_workspace)
+    lib.tag_release(dist_dir, release_message, tag_message, no_git_tag_workspace)
 
 
 @main.command()
@@ -425,6 +437,12 @@ def tag_release(dist_dir, no_git_tag_workspace):
     envvar="RH_POST_VERSION_SPEC",
     help="The post release version (usually dev)",
 )
+@click.option(
+    "--post-version-message",
+    default="Bumped version to {post_version}",
+    envvar="RH_POST_VERSION_MESSAGE",
+    help="The post release message",
+)
 @click.argument("assets", nargs=-1)
 @use_checkout_dir()
 def draft_release(
@@ -437,6 +455,7 @@ def draft_release(
     dist_dir,
     dry_run,
     post_version_spec,
+    post_version_message,
     assets,
 ):
     """Publish Draft GitHub release"""
@@ -450,6 +469,7 @@ def draft_release(
         dist_dir,
         dry_run,
         post_version_spec,
+        post_version_message,
         assets,
     )
 

jupyter_releaser/lib.py

@@ -169,19 +169,20 @@ def make_changelog_pr(auth, branch, repo, title, commit_message, body, dry_run=F
     util.actions_output("pr_url", pull.html_url)
 
 
-def tag_release(dist_dir, no_git_tag_workspace):
+def tag_release(dist_dir, release_message, tag_message, no_git_tag_workspace):
     """Create release commit and tag"""
     # Get the new version
     version = util.get_version()
 
     # Create the release commit
-    util.create_release_commit(version, dist_dir)
+    util.create_release_commit(version, release_message, dist_dir)
 
     # Create the annotated release tag
     tag_name = f"v{version}"
-    util.run(f'git tag {tag_name} -a -m "Release {tag_name}"')
+    tag_message = tag_message.format(tag_name=tag_name)
+    util.run(f'git tag {tag_name} -a -m "{tag_message}"')
 
-    # Create annotated release tags for workspace packages if given
+    # Create release tags for workspace packages if given
     if not no_git_tag_workspace:
         npm.tag_workspace_packages()
 
@@ -196,6 +197,7 @@ def draft_release(
     dist_dir,
     dry_run,
     post_version_spec,
+    post_version_message,
     assets,
 ):
     """Publish Draft GitHub release and handle post version bump"""
@@ -209,8 +211,7 @@ def draft_release(
     # Bump to post version if given
     if post_version_spec:
         post_version = bump_version(post_version_spec, version_cmd)
-
-        util.log(f"Bumped version to {post_version}")
+        util.log(post_version_message.format(post_version=post_version))
         util.run(f'git commit -a -m "Bump to {post_version}"')
 
     if dry_run:

jupyter_releaser/tests/test_cli.py

@@ -159,11 +159,14 @@ def test_list_envvars(runner):
 npm-install-options: RH_NPM_INSTALL_OPTIONS
 npm-token: NPM_TOKEN
 output: RH_CHANGELOG_OUTPUT
+post-version-message: RH_POST_VERSION_MESSAGE
 post-version-spec: RH_POST_VERSION_SPEC
 ref: RH_REF
+release-message: RH_RELEASE_MESSAGE
 repo: RH_REPOSITORY
 resolve-backports: RH_RESOLVE_BACKPORTS
 since: RH_SINCE
+tag-message: RH_TAG_MESSAGE
 twine-cmd: TWINE_COMMAND
 username: GITHUB_ACTOR
 version-cmd: RH_VERSION_COMMAND
@@ -441,7 +444,15 @@ def test_tag_release(py_package, runner, build_mock, git_prep):
     # Create the dist files
     util.run("python -m build .", cwd=util.CHECKOUT_NAME)
     # Tag the release
-    runner(["tag-release"])
+    runner(
+        [
+            "tag-release",
+            "--release-message",
+            "hi {version}",
+            "--tag-message",
+            "no thanks",
+        ]
+    )
 
     log = get_log()
     assert "before-tag-release" in log
@@ -450,7 +461,16 @@ def test_tag_release(py_package, runner, build_mock, git_prep):
 
 def test_draft_release_dry_run(py_dist, mocker, runner, open_mock, git_prep):
     # Publish the release - dry run
-    runner(["draft-release", "--dry-run", "--post-version-spec", "1.1.0.dev0"])
+    runner(
+        [
+            "draft-release",
+            "--dry-run",
+            "--post-version-spec",
+            "1.1.0.dev0",
+            "--post-version-message",
+            "haha",
+        ]
+    )
     open_mock.assert_not_called()
 
     log = get_log()

jupyter_releaser/util.py

@@ -161,9 +161,11 @@ def compute_sha256(path):
     return sha256.hexdigest()
 
 
-def create_release_commit(version, dist_dir="dist"):
+def create_release_commit(version, release_message=None, dist_dir="dist"):
     """Generate a release commit that has the sha256 digests for the release files"""
-    cmd = f'git commit -am "Publish {version}" -m "SHA256 hashes:"'
+    release_message = release_message or "Publish {version}"
+    release_message = release_message.format(version=version)
+    cmd = f'git commit -am "{release_message}" -m "SHA256 hashes:"'
 
     shas = dict()