Merge pull request #223 from blink1073/default-branch

Make branch and version spec optional

Author: jtpio

.github/workflows/draft-changelog.yml

@@ -7,16 +7,12 @@ on:
         required: true
       branch:
         description: "The branch to target"
-        required: true
       version_spec:
         description: "New Version Spec"
-        required: true
       since:
         description: Use PRs with activity since this date or git reference
-        required: false
       since_last_stable:
         description: Use PRs with activity since the last stable git tag
-        required: false
 jobs:
   draft_changelog:
     runs-on: ubuntu-latest

.github/workflows/draft-release.yml

@@ -7,22 +7,16 @@ on:
         required: true
       branch:
         description: "The branch to target"
-        required: true
       version_spec:
         description: "New Version Specifier"
-        required: true
       post_version_spec:
         description: "Post Version Specifier"
-        required: false
       since:
         description: Use PRs with activity since this date or git reference
-        required: false
       since_last_stable:
         description: Use PRs with activity since the last stable git tag
-        required: false
       steps_to_skip:
         description: Comma separated list of steps to skip
-        required: false
 jobs:
   draft_release:
     runs-on: ubuntu-latest

.github/workflows/full-release.yml

@@ -7,22 +7,16 @@ on:
         required: true
       branch:
         description: "The branch to target"
-        required: true
       version_spec:
         description: "New Version Specifier"
-        required: true
       post_version_spec:
         description: "Post Version Specifier"
-        required: false
       since:
         description: Use PRs with activity since this date or git reference
-        required: false
       since_last_stable:
         description: Use PRs with activity since the last stable git tag
-        required: false
       steps_to_skip:
         description: Comma separated list of steps to skip
-        required: false
 
 jobs:
   full_release:

.github/workflows/generate-changelog.yml

@@ -7,16 +7,12 @@ on:
         required: true
       branch:
         description: The branch or reference name to filter pull requests by
-        required: true
       convert_to_rst:
         description: Whether to convert to RST
-        required: false
       since:
         description: Use PRs with activity since this date or git reference
-        required: false
       until:
         description: Use PRs with activity until this date or git reference
-        required: false
 jobs:
   generate_changelog:
     runs-on: ubuntu-latest

.github/workflows/publish-release.yml

@@ -6,8 +6,7 @@ on:
         description: "The URL of the draft GitHub release"
         required: true
       steps_to_skip:
-        description: comma-separated list of steps to steps_to_skip
-        required: false
+        description: comma-separated list of steps to skip
 jobs:
   publish_release:
     runs-on: ubuntu-latest

jupyter_releaser/actions/common.py

@@ -6,7 +6,8 @@ def setup():
     os.environ.setdefault("RH_REPOSITORY", os.environ["GITHUB_REPOSITORY"])
     os.environ.setdefault("RH_REF", os.environ["GITHUB_REF"])
 
-    if not os.environ.get("RH_BRANCH"):
+    check_release = os.environ.get("RH_IS_CHECK_RELEASE", "").lower() == "true"
+    if not os.environ.get("RH_BRANCH") and check_release:
         if os.environ.get("GITHUB_BASE_REF"):
             base_ref = os.environ.get("GITHUB_BASE_REF")
             print(f"Using GITHUB_BASE_REF: ${base_ref}")

jupyter_releaser/actions/generate-changelog.py

@@ -3,10 +3,11 @@
 
 from jupyter_releaser.changelog import get_version_entry
 from jupyter_releaser.util import CHECKOUT_NAME
+from jupyter_releaser.util import get_branch
 from jupyter_releaser.util import run
 
 target = os.environ.get("RH_REPOSITORY")
-branch = os.environ.get("RH_BRANCH")
+branch = os.environ.get("RH_BRANCH", "<default>")
 ref = os.environ.get("RH_REF")
 since = os.environ.get("RH_SINCE")
 until = os.environ.get("RH_UNTIL")
@@ -18,6 +19,7 @@
 print("convert to rst:", convert_to_rst)
 
 run("jupyter-releaser prep-git")
+branch = get_branch()
 orig_dir = os.getcwd()
 os.chdir(CHECKOUT_NAME)
 output = get_version_entry(ref, branch, target, "current", since=since, until=until)

jupyter_releaser/changelog.py

@@ -80,6 +80,7 @@ def get_version_entry(
     str
         A formatted changelog entry with markers
     """
+    branch = branch or util.get_branch()
     since = since or util.get_latest_tag(ref or branch, since_last_stable)
 
     util.log(f"Getting changes to {repo} since {since} on branch {branch}...")

jupyter_releaser/lib.py

@@ -139,6 +139,7 @@ def draft_changelog(
 
 def make_changelog_pr(auth, branch, repo, title, commit_message, body, dry_run=False):
     repo = repo or util.get_repo()
+    branch = branch or util.get_branch()
 
     # Make a new branch with a uuid suffix
     pr_branch = f"changelog-{uuid.uuid1().hex}"

jupyter_releaser/util.py

@@ -108,16 +108,7 @@ def log(*outputs, **kwargs):
 
 def get_branch():
     """Get the appropriate git branch"""
-    if os.environ.get("GITHUB_HEAD_REF"):
-        # GitHub Action PR Event
-        branch = os.environ["GITHUB_HEAD_REF"]
-    elif os.environ.get("GITHUB_REF"):
-        # GitHub Action Push Event
-        # e.g. refs/heads/feature-branch-1
-        branch = "/".join(os.environ["GITHUB_REF"].split("/")[2:])
-    else:
-        branch = run("git branch --show-current")
-    return branch
+    return run("git branch --show-current")
 
 
 def get_default_branch():
@@ -267,6 +258,7 @@ def actions_output(name, value):
 
 def get_latest_tag(source, since_last_stable=False):
     """Get the default 'since' value for a branch"""
+    source = source or get_branch()
     tags = run(f"git --no-pager tag --sort=-creatordate --merged {source}", quiet=True)
     if not tags:
         return ""