Skip to content

Commit 5369080

Browse files
authored
Minor updates to changelog generation script (#21038)
1 parent c4f236f commit 5369080

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

misc/generate_changelog.py

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ def filter_omitted_commits(commits: list[CommitInfo]) -> list[CommitInfo]:
8383
):
8484
# These are generated by a typeshed sync.
8585
keep = False
86-
if re.search(r"(bump|update).*version.*\+dev", title.lower()):
86+
if re.search(r"(bump|update).*version", title.lower()):
8787
# Version number updates aren't mentioned
8888
keep = False
8989
if "pre-commit autoupdate" in title:
@@ -155,13 +155,19 @@ def format_changelog_entry(c: CommitInfo) -> str:
155155

156156

157157
def main() -> None:
158-
parser = argparse.ArgumentParser()
158+
parser = argparse.ArgumentParser(
159+
description="Generate draft .md changelog for a mypy public release and print it to stdout."
160+
)
159161
parser.add_argument("version", help="target mypy version (form X.Y)")
160-
parser.add_argument("--local", action="store_true")
162+
parser.add_argument(
163+
"--local", action="store_true", help="use local release branch, not origin"
164+
)
161165
args = parser.parse_args()
162166
version: str = args.version
163167
local: bool = args.local
164168

169+
version = version.removeprefix("v")
170+
165171
if not re.match(r"[0-9]+\.[0-9]+$", version):
166172
sys.exit(f"error: Release must be of form X.Y (not {version!r})")
167173
major, minor = (int(component) for component in version.split("."))
@@ -187,7 +193,10 @@ def main() -> None:
187193
print(f"Generating changelog for {major}.{minor}")
188194
print(f"Previous release was {prev_major}.{prev_minor}")
189195

190-
new_branch = f"origin/release-{major}.{minor}"
196+
if local:
197+
new_branch = f"release-{major}.{minor}"
198+
else:
199+
new_branch = f"origin/release-{major}.{minor}"
191200
old_branch = f"origin/release-{prev_major}.{prev_minor}"
192201

193202
changes = find_changes_between_releases(old_branch, new_branch)

0 commit comments

Comments
 (0)