diff --git a/jupyter_releaser/changelog.py b/jupyter_releaser/changelog.py index cb338719..40ec1a30 100644 --- a/jupyter_releaser/changelog.py +++ b/jupyter_releaser/changelog.py @@ -40,7 +40,9 @@ def format_pr_entry(target, number, auth=None): return f"- {title} [#{number}]({url}) ([@{user_name}]({user_url}))" -def get_version_entry(branch, repo, version, *, auth=None, resolve_backports=False): +def get_version_entry( + branch, repo, version, *, since=None, auth=None, resolve_backports=False +): """Get a changelog for the changes since the last tag on the given branch. Parameters @@ -51,6 +53,8 @@ def get_version_entry(branch, repo, version, *, auth=None, resolve_backports=Fal The GitHub owner/repo version : str The new version + since: str + Use PRs with activity since this date or git reference auth : str, optional The GitHub authorization token resolve_backports: bool, optional @@ -65,7 +69,7 @@ def get_version_entry(branch, repo, version, *, auth=None, resolve_backports=Fal if not tags: # pragma: no cover raise ValueError(f"No tags found on branch {branch}") - since = tags.splitlines()[0] + since = since or tags.splitlines()[0] branch = branch.split("/")[-1] util.log(f"Getting changes to {repo} since {since} on branch {branch}...") @@ -120,7 +124,7 @@ def get_version_entry(branch, repo, version, *, auth=None, resolve_backports=Fal return output -def build_entry(branch, repo, auth, changelog_path, resolve_backports): +def build_entry(branch, repo, auth, changelog_path, since, resolve_backports): """Build a python version entry""" branch = branch or util.get_branch() repo = repo or util.get_repo() @@ -142,6 +146,7 @@ def build_entry(branch, repo, auth, changelog_path, resolve_backports): f"origin/{branch}", repo, version, + since=since, auth=auth, resolve_backports=resolve_backports, ) @@ -186,7 +191,7 @@ def format(changelog): return re.sub(r"\n\n+$", r"\n", changelog) -def check_entry(branch, repo, auth, changelog_path, resolve_backports, output): +def check_entry(branch, repo, auth, changelog_path, since, resolve_backports, output): """Check changelog entry""" branch = branch or util.get_branch() @@ -213,6 +218,7 @@ def check_entry(branch, repo, auth, changelog_path, resolve_backports, output): f"origin/{branch}", repo, version, + since=since, auth=auth, resolve_backports=resolve_backports, ) diff --git a/jupyter_releaser/cli.py b/jupyter_releaser/cli.py index 699b7c34..b8a05551 100644 --- a/jupyter_releaser/cli.py +++ b/jupyter_releaser/cli.py @@ -170,10 +170,20 @@ def main(): ), ] +since_options = [ + click.option( + "--since", + envvar="RH_SINCE", + default=None, + help="Use PRs with activity since this date or git reference", + ) +] + changelog_options = ( branch_options + auth_options + changelog_path_options + + since_options + [ click.option( "--resolve-backports", @@ -235,20 +245,21 @@ def bump_version(version_spec, version_cmd): @main.command() @add_options(changelog_options) @use_checkout_dir() -def build_changelog(ref, branch, repo, auth, changelog_path, resolve_backports): +def build_changelog(ref, branch, repo, auth, changelog_path, since, resolve_backports): """Build changelog entry""" - changelog.build_entry(branch, repo, auth, changelog_path, resolve_backports) + changelog.build_entry(branch, repo, auth, changelog_path, since, resolve_backports) @main.command() @add_options(version_spec_options) @add_options(branch_options) +@add_options(since_options) @add_options(auth_options) @add_options(dry_run_options) @use_checkout_dir() -def draft_changelog(version_spec, ref, branch, repo, auth, dry_run): +def draft_changelog(version_spec, ref, branch, repo, since, auth, dry_run): """Create a changelog entry PR""" - lib.draft_changelog(version_spec, branch, repo, auth, dry_run) + lib.draft_changelog(version_spec, branch, repo, since, auth, dry_run) @main.command() @@ -257,9 +268,13 @@ def draft_changelog(version_spec, ref, branch, repo, auth, dry_run): "--output", envvar="RH_CHANGELOG_OUTPUT", help="The output file for changelog entry" ) @use_checkout_dir() -def check_changelog(ref, branch, repo, auth, changelog_path, resolve_backports, output): +def check_changelog( + ref, branch, repo, auth, changelog_path, since, resolve_backports, output +): """Check changelog entry""" - changelog.check_entry(branch, repo, auth, changelog_path, resolve_backports, output) + changelog.check_entry( + branch, repo, auth, changelog_path, since, resolve_backports, output + ) @main.command() diff --git a/jupyter_releaser/lib.py b/jupyter_releaser/lib.py index fa229e91..5ac718c5 100644 --- a/jupyter_releaser/lib.py +++ b/jupyter_releaser/lib.py @@ -84,7 +84,7 @@ def check_links(ignore_glob, ignore_links, cache_file, links_expire): util.run(file_cmd + " --lf") -def draft_changelog(version_spec, branch, repo, auth, dry_run): +def draft_changelog(version_spec, branch, repo, since, auth, dry_run): """Create a changelog entry PR""" repo = repo or util.get_repo() branch = branch or util.get_branch() @@ -105,7 +105,7 @@ def draft_changelog(version_spec, branch, repo, auth, dry_run): if util.PACKAGE_JSON.exists(): body += npm.get_package_versions(version) - body += '\n\nAfter merging this PR run the "Draft Release" Workflow with the following inputs' + body += '\n\nAfter merging this PR run the "Draft Release" Workflow on your fork of `jupyter_releaser` with the following inputs' body += f""" | Input | Value | | ------------- | ------------- | @@ -113,6 +113,8 @@ def draft_changelog(version_spec, branch, repo, auth, dry_run): | Branch | {branch} | | Version Spec | {version_spec} | """ + if since: + body += "| Since | {since} |" util.log(body) make_changelog_pr(auth, branch, repo, title, commit_message, body, dry_run=dry_run) diff --git a/jupyter_releaser/tests/test_cli.py b/jupyter_releaser/tests/test_cli.py index 1fbfef10..3a22f630 100644 --- a/jupyter_releaser/tests/test_cli.py +++ b/jupyter_releaser/tests/test_cli.py @@ -129,6 +129,7 @@ def test_list_envvars(runner): ref: RH_REF repo: RH_REPOSITORY resolve-backports: RH_RESOLVE_BACKPORTS +since: RH_SINCE test-cmd: RH_NPM_TEST_COMMAND twine-cmd: TWINE_COMMAND username: GITHUB_ACTOR