Skip to content

Fix release notes generation #6399

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 3, 2025
Merged

Fix release notes generation #6399

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions tasks/release.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,12 @@ def _render_log(ctx=None, version=None):
if ctx and not version:
version = find_version(ctx)

# Towncrier expects --version to be a flag to show its own version
# For setting the project version, we need to use a positional argument
cmd = ["towncrier", "--draft"]
if version:
cmd.append(f"--name={version}") # Use --name instead of --version
# Add version as a positional argument
cmd.append(version)

rendered = subprocess.check_output(cmd).decode("utf-8")
return rendered
Expand All @@ -79,7 +82,7 @@ def release(
tag_content = _render_log(ctx, version)
if dry_run:
# Use the correct version when generating the draft
ctx.run(f"towncrier --draft --name={version} > CHANGELOG.draft.md")
ctx.run(f"towncrier --draft {version} > CHANGELOG.draft.md")
log("would remove: news/*")
log("would remove: CHANGELOG.draft.md")
log("would update: pipenv/pipenv.1")
Expand All @@ -88,11 +91,11 @@ def release(
if pre:
log("generating towncrier draft...")
# Use the correct version when generating the draft
ctx.run(f"towncrier --draft --name={version} > CHANGELOG.draft.md")
ctx.run(f"towncrier --draft {version} > CHANGELOG.draft.md")
ctx.run(f"git add {get_version_file(ctx).as_posix()}")
else:
# Use the correct version when generating the changelog
ctx.run(f"towncrier --name={version}")
ctx.run(f"towncrier {version}")
ctx.run(f"git add CHANGELOG.md news/ {get_version_file(ctx).as_posix()}")
log("removing changelog draft if present")
draft_changelog = pathlib.Path("CHANGELOG.draft.md")
Expand Down