Skip to content

Commit b664cda

Browse files
committed
Add new line after header at the top of the versionsed changelog
1 parent 8e23fb1 commit b664cda

File tree

3 files changed

+7
-1
lines changed

3 files changed

+7
-1
lines changed

doc/changes/unreleased.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,7 @@
33
## Documentation
44

55
* #589: Corrected configuration for Sonar documentation for host.url
6+
7+
## Refactoring
8+
9+
* #589: Added newline after header in versioned changelog

exasol/toolbox/util/release/changelog.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ def _create_versioned_changelog(self, unreleased_content: str) -> None:
5050
if dependency_changes := self._describe_dependency_changes():
5151
dependency_content = f"## Dependency Updates\n{dependency_changes}"
5252

53-
template = cleandoc(f"{header}\n{unreleased_content}\n{dependency_content}")
53+
template = cleandoc(f"{header}\n\n{unreleased_content}\n{dependency_content}")
5454
self.versioned_changelog_md.write_text(template + "\n")
5555

5656
def _extract_unreleased_notes(self) -> str:

test/unit/util/release/changelog_test.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,7 @@ def test_update_changelogs_for_release(
181181
saved_text
182182
== cleandoc(
183183
f"""# 1.0.0 - {datetime.today().strftime('%Y-%m-%d')}
184+
184185
## Added
185186
* Added Awesome feature
186187
@@ -218,6 +219,7 @@ def test_update_changelogs_for_release_with_no_dependencies(
218219
saved_text
219220
== cleandoc(
220221
f"""# 1.0.0 - {datetime.today().strftime('%Y-%m-%d')}
222+
221223
## Added
222224
* Added Awesome feature
223225

0 commit comments

Comments
 (0)