diff --git a/CHANGELOG.md b/CHANGELOG.md index 02faad698..5921dd1c7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,12 @@ +## v7.34.3 (2023-06-01) + +### Fix + +* Generate markdown linter compliant changelog headers & lists ([#597](https://github.com/python-semantic-release/python-semantic-release/issues/597)) ([`cc87400`](https://github.com/python-semantic-release/python-semantic-release/commit/cc87400d4a823350de7d02dc3172d2488c9517db)) + ## v7.34.2 (2023-05-29) ### Fix diff --git a/semantic_release/__init__.py b/semantic_release/__init__.py index dcbe417d5..8ac3c318e 100644 --- a/semantic_release/__init__.py +++ b/semantic_release/__init__.py @@ -1,6 +1,6 @@ """Semantic Release """ -__version__ = "7.34.2" +__version__ = "7.34.3" from .errors import UnknownCommitMessageStyleError # noqa; noqa diff --git a/semantic_release/vcs_helpers.py b/semantic_release/vcs_helpers.py index 641f33f75..c22eb7480 100644 --- a/semantic_release/vcs_helpers.py +++ b/semantic_release/vcs_helpers.py @@ -208,7 +208,7 @@ def update_changelog_file(version: str, content_to_add: str): [ changelog_placeholder, "", - f"## v{version} ({date.today():%Y-%m-%d})", + f"## v{version} ({date.today():%Y-%m-%d})\n", content_to_add, ] ), diff --git a/tests/test_vcs_helpers.py b/tests/test_vcs_helpers.py index 655b07056..8544f2d56 100644 --- a/tests/test_vcs_helpers.py +++ b/tests/test_vcs_helpers.py @@ -444,7 +444,7 @@ def test_update_changelog_file_ok(mock_git, mocker): "\n" "\n" "\n" - "## v1.0.0 (2015-08-04)\n" + "## v1.0.0 (2015-08-04)\n\n" "### Feature\n" "* Just a start" ) @@ -464,13 +464,13 @@ def test_update_changelog_file_ok(mock_git, mocker): "\n" "\n" "\n" - f"## v2.0.0 ({date.today():%Y-%m-%d})\n" + f"## v2.0.0 ({date.today():%Y-%m-%d})\n\n" "### Fix\n" "* Fix a bug\n" "### Feature\n" "* Add something awesome\n" "\n" - "## v1.0.0 (2015-08-04)\n" + "## v1.0.0 (2015-08-04)\n\n" "### Feature\n" "* Just a start" ) @@ -491,7 +491,7 @@ def test_update_changelog_file_missing_file(mock_git, mocker): "\n" "\n" "\n" - f"## v2.0.0 ({date.today():%Y-%m-%d})\n" + f"## v2.0.0 ({date.today():%Y-%m-%d})\n\n" "* Some new content\n" ) @@ -513,7 +513,7 @@ def test_update_changelog_file_missing_placeholder_but_containing_header( "\n" "\n" "\n" - f"## v2.0.0 ({date.today():%Y-%m-%d})\n" + f"## v2.0.0 ({date.today():%Y-%m-%d})\n\n" "* Some new content\n" ) @@ -531,7 +531,7 @@ def test_update_changelog_empty_file(mock_git, mocker): "\n" "\n" "\n" - f"## v2.0.0 ({date.today():%Y-%m-%d})\n" + f"## v2.0.0 ({date.today():%Y-%m-%d})\n\n" "* Some new content\n" )