Skip to content

Commit d34caa9

Browse files
committed
fix: Also render title in markdown template without name
1 parent 212a938 commit d34caa9

3 files changed

Lines changed: 49 additions & 1 deletion

File tree

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
The default Markdown template now renders a title containing the release version and date, even when the `name` configuration is left empty.

src/towncrier/templates/default.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
{% if versiondata.name %}
33
# {{ versiondata.name }} {{ versiondata.version }} ({{ versiondata.date }})
44
{% else %}
5-
{{ versiondata.version }} ({{ versiondata.date }})
5+
# {{ versiondata.version }} ({{ versiondata.date }})
66
{% endif %}
77
{% endif %}
88
{% for section, _ in sections.items() %}

src/towncrier/test/test_build.py

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1248,6 +1248,53 @@ def test_default_start_string_markdown(self, runner):
12481248

12491249
self.assertEqual(expected_output, output)
12501250

1251+
@with_project(
1252+
config="""
1253+
[tool.towncrier]
1254+
name = ""
1255+
directory = "changes"
1256+
filename = "NEWS.md"
1257+
version = "1.2.3"
1258+
"""
1259+
)
1260+
def test_markdown_no_name_title(self, runner):
1261+
"""
1262+
When configured with an empty `name` option,
1263+
the default template used for Markdown
1264+
renders the title of the release note with just
1265+
the version number and release date.
1266+
"""
1267+
write("changes/123.feature", "Adds levitation")
1268+
write(
1269+
"NEWS.md",
1270+
contents="""
1271+
A line
1272+
1273+
<!-- towncrier release notes start -->
1274+
""",
1275+
dedent=True,
1276+
)
1277+
1278+
result = runner.invoke(_main, ["--date", "01-01-2001"], catch_exceptions=False)
1279+
self.assertEqual(0, result.exit_code, result.output)
1280+
output = read("NEWS.md")
1281+
1282+
expected_output = dedent(
1283+
"""
1284+
A line
1285+
1286+
<!-- towncrier release notes start -->
1287+
1288+
# 1.2.3 (01-01-2001)
1289+
1290+
### Features
1291+
1292+
- Adds levitation (#123)
1293+
"""
1294+
)
1295+
1296+
self.assertEqual(expected_output, output)
1297+
12511298
@with_project(
12521299
config="""
12531300
[tool.towncrier]

0 commit comments

Comments
 (0)