Skip to content

Commit e333fe5

Browse files
Update default changelog title
This updates the default changelog title and makes it configurable.
1 parent be42bb7 commit e333fe5

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

.changes/smithy_changelog/render.py

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@
1717
"available."
1818
) from e
1919

20-
TITLE = "Changelog"
20+
21+
_DEFAULT_TITLE = "Smithy Changelog"
2122

2223

2324
def main() -> None:
@@ -26,6 +27,12 @@ def main() -> None:
2627
Render the changelog as markdown, optionally including pending features \
2728
as a new release.""",
2829
)
30+
parser.add_argument(
31+
"-t",
32+
"--title",
33+
help="The top-level title to use for the changelog file.",
34+
default=_DEFAULT_TITLE,
35+
)
2936
release_group = parser.add_argument_group(
3037
"release",
3138
description="""\
@@ -55,11 +62,11 @@ def main() -> None:
5562
if args.release_version:
5663
_release(args.release_version, args.release_date)
5764

58-
render()
65+
render(title=args.title)
5966

6067

61-
def render() -> None:
62-
rendered = f"# {TITLE}\n\n"
68+
def render(title: str = _DEFAULT_TITLE) -> None:
69+
rendered = f"# {title}\n\n"
6370
for release in get_releases():
6471
if isinstance(release, str):
6572
rendered += release + "\n"

0 commit comments

Comments
 (0)