python-semantic-release 9.11.1__tar.gz → 9.12.1__tar.gz

{python_semantic_release-9.11.1/python_semantic_release.egg-info → python_semantic_release-9.12.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-semantic-release
-Version: 9.11.1
+Version: 9.12.1
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT
@@ -43,13 +43,14 @@ Provides-Extra: test
 Requires-Dist: coverage[toml]~=7.0; extra == "test"
 Requires-Dist: pyyaml~=6.0; extra == "test"
 Requires-Dist: pytest~=8.3; extra == "test"
+Requires-Dist: pytest-clarity~=1.0; extra == "test"
+Requires-Dist: pytest-cov~=5.0; extra == "test"
 Requires-Dist: pytest-env~=1.0; extra == "test"
-Requires-Dist: pytest-xdist~=3.0; extra == "test"
-Requires-Dist: pytest-mock~=3.0; extra == "test"
 Requires-Dist: pytest-lazy-fixtures~=1.1.1; extra == "test"
-Requires-Dist: pytest-cov~=5.0; extra == "test"
+Requires-Dist: pytest-mock~=3.0; extra == "test"
+Requires-Dist: pytest-order~=1.3; extra == "test"
 Requires-Dist: pytest-pretty~=1.2; extra == "test"
-Requires-Dist: pytest-clarity~=1.0; extra == "test"
+Requires-Dist: pytest-xdist~=3.0; extra == "test"
 Requires-Dist: responses~=0.25.0; extra == "test"
 Requires-Dist: requests-mock~=1.10; extra == "test"
 Provides-Extra: dev

{python_semantic_release-9.11.1 → python_semantic_release-9.12.1}/docs/automatic-releases/github-actions.rst

@@ -337,7 +337,7 @@ before the :ref:`version <cmd-version>` subcommand.
 
   .. code:: yaml
 
-    - uses: python-semantic-release/python-semantic-release@v9.11.1
+    - uses: python-semantic-release/python-semantic-release@v9.12.1
       with:
         root_options: "-vv --noop"
 
@@ -684,7 +684,7 @@ to the GitHub Release Assets as well.
           - name: Action | Semantic Version Release
             id: release
             # Adjust tag with desired version if applicable.
-            uses: python-semantic-release/python-semantic-release@v9.11.1
+            uses: python-semantic-release/python-semantic-release@v9.12.1
             with:
               github_token: ${{ secrets.GITHUB_TOKEN }}
               git_committer_name: "github-actions"
@@ -744,7 +744,7 @@ The equivalent GitHub Action configuration would be:
 
   - name: Action | Semantic Version Release
     # Adjust tag with desired version if applicable.
-    uses: python-semantic-release/python-semantic-release@v9.11.1
+    uses: python-semantic-release/python-semantic-release@v9.12.1
     with:
       github_token: ${{ secrets.GITHUB_TOKEN }}
       force: patch
@@ -772,13 +772,13 @@ Publish Action.
 .. code:: yaml
 
    - name: Release Project 1
-     uses: python-semantic-release/python-semantic-release@v9.11.1
+     uses: python-semantic-release/python-semantic-release@v9.12.1
      with:
        directory: ./project1
        github_token: ${{ secrets.GITHUB_TOKEN }}
 
    - name: Release Project 2
-     uses: python-semantic-release/python-semantic-release@v9.11.1
+     uses: python-semantic-release/python-semantic-release@v9.12.1
      with:
        directory: ./project2
        github_token: ${{ secrets.GITHUB_TOKEN }}

{python_semantic_release-9.11.1 → python_semantic_release-9.12.1}/docs/changelog_templates.rst

@@ -587,6 +587,24 @@ arguments are passed in parentheses like normal function calls.
 
 The filters provided vary based on the VCS configured and available features:
 
+* ``autofit_text_width (Callable[[textStr, maxWidthInt, indent_sizeInt], textStr])``: given a
+  text string, fit the text to the maximum width provided. This filter is useful when you want
+  to wrap text to a specific width. The filter will attempt to break the text at word boundaries
+  and will indent the text by the amount specified in the ``indent_size`` parameter.
+
+  *Introduced in v9.12.0.*
+
+  **Example Usage:**
+
+  .. code:: jinja
+
+      {{ "This is a long string that needs to be wrapped to a specific width" | autofit_text_width(40, 4) }}
+
+  .. code:: markdown
+
+      This is a long string that needs to be
+          wrapped to a specific width
+
 * ``convert_md_to_rst (Callable[[MdStr], RstStr])``: given a markdown string, convert it to
   reStructuredText format. This filter is useful when building a reStructuredText changelog
   but your commit messages are in markdown format. It is utilized by the default RST changelog
@@ -744,6 +762,7 @@ Availability of the documented filters can be found in the table below:
 ======================  =========  =====  ======  ======
 **filter - hvcs_type**  bitbucket  gitea  github  gitlab
 ======================  =========  =====  ======  ======
+autofit_text_width         ✅       ✅      ✅      ✅
 convert_md_to_rst          ✅       ✅      ✅      ✅
 create_server_url          ✅       ✅      ✅      ✅
 create_repo_url            ✅       ✅      ✅      ✅
@@ -844,7 +863,7 @@ the template directory structure and modularity is maintained.
 .. tip::
     When initially starting out at customizing your own release notes template, you
     should reference the default template embedded within PSR. The release notes template
-    can be found in the directory ``data/templates/<parser>`` within the PSR package.
+    can be found in the directory ``data/templates/<parser>/md`` within the PSR package.
 
 
 .. _changelog-templates-custom_release_notes-context:
@@ -999,29 +1018,29 @@ __ https://github.com/python-semantic-release/python-semantic-release/tree/maste
 2.  **Use the new read_file filter** to read in the existing changelog file
     ``ctx.prev_changelog_file``. This will allow you to include the existing
     changelog content in your new changelog file. See
-    ``data/templates/*/md/.changelog_update.md.j2`` for reference.
+    ``data/templates/*/md/.components/changelog_update.md.j2`` for reference.
 
 3.  **Split the changelog content based on the insertion flag.** This will
     allow you to insert the new release information after the insertion flag
     (``ctx.changelog_insertion_flag``). See
-    ``data/templates/*/md/.changelog_update.md.j2`` for reference.
+    ``data/templates/*/md/.components/changelog_update.md.j2`` for reference.
 
 4.  **Print the leading content before the insertion flag.** This ensures you
     maintain any content that should be included before the new release information.
-    See ``data/templates/*/md/.changelog_update.md.j2`` for reference.
+    See ``data/templates/*/md/.components/changelog_update.md.j2`` for reference.
 
 5.  **Print your insertion flag.** This is impartive to ensure that the resulting
     changelog can be updated in the future. See
-    ``data/templates/*/md/.changelog_update.md.j2`` for reference.
+    ``data/templates/*/md/.components/changelog_update.md.j2`` for reference.
 
 6.  **Print the new release information.** Be sure to consider both unreleased
     and released commits during this step because of the :ref:`cmd-changelog`
     command that can be run at any time. See
-    ``data/templates/*/md/.changelog_update.md.j2`` for reference.
+    ``data/templates/*/md/.components/changelog_update.md.j2`` for reference.
 
 7.  **Print the trailing content after the insertion flag.** This ensures you
     maintain any content that should be included after the new release information.
-    See ``data/templates/*/md/.changelog_update.md.j2`` for reference.
+    See ``data/templates/*/md/.components/changelog_update.md.j2`` for reference.
 
 
 .. tip::

{python_semantic_release-9.11.1 → python_semantic_release-9.12.1}/docs/commit-parsing.rst

@@ -160,6 +160,9 @@ The default configuration options for
 ``semantic_release.history.TagCommitParser``
 """"""""""""""""""""""""""""""""""""""""""""
 
+.. warning::
+  This parser was deprecated in ``v9.12.0``. It will be removed in a future release.
+
 The original parser from v1.0.0 of Python Semantic Release. Similar to the
 emoji parser above, but with less features.
 

{python_semantic_release-9.11.1 → python_semantic_release-9.12.1}/docs/configuration.rst

@@ -763,7 +763,7 @@ Built-in parsers:
     * ``angular`` - :ref:`AngularCommitParser <commit-parser-angular>`
     * ``emoji`` - :ref:`EmojiCommitParser <commit-parser-emoji>`
     * ``scipy`` - :ref:`ScipyCommitParser <commit-parser-scipy>`
-    * ``tag`` - :ref:`TagCommitParser <commit-parser-tag>`
+    * ``tag`` - :ref:`TagCommitParser <commit-parser-tag>` *(deprecated in v9.12.0)*
 
 You can set any of the built-in parsers by their keyword but you can also specify
 your own commit parser in ``module:attr`` form.

{python_semantic_release-9.11.1 → python_semantic_release-9.12.1}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-semantic-release"
-version = "9.11.1"
+version = "9.12.1"
 description = "Automatic Semantic Versioning for Python projects"
 requires-python = ">=3.8"
 license = { text = "MIT" }
@@ -61,13 +61,14 @@ test = [
   "coverage[toml] ~= 7.0",
   "pyyaml ~= 6.0",
   "pytest ~= 8.3",
+  "pytest-clarity ~= 1.0",
+  "pytest-cov ~= 5.0",
   "pytest-env ~= 1.0",
-  "pytest-xdist ~= 3.0",
-  "pytest-mock ~= 3.0",
   "pytest-lazy-fixtures ~= 1.1.1",
-  "pytest-cov ~= 5.0",
+  "pytest-mock ~= 3.0",
+  "pytest-order ~= 1.3",
   "pytest-pretty ~= 1.2",
-  "pytest-clarity ~= 1.0",
+  "pytest-xdist ~= 3.0",
   "responses ~= 0.25.0",
   "requests-mock ~= 1.10",
 ]
@@ -97,6 +98,7 @@ addopts = [
   "-ra",
   "--diff-symbols",
   "--cache-clear",
+  "--durations=20",
   # No default coverage - causes problems with debuggers
   # "--cov=semantic_release",
   # "--cov-context=test",
@@ -106,6 +108,11 @@ addopts = [
 testpaths = [
   "tests"
 ]
+markers = [
+  "unit: mark a test as a unit test",
+  "e2e: mark a test as a end-to-end test",
+  "comprehensive: mark a test as a comprehensive (multiple variations) test",
+]
 
 [tool.coverage.html]
 show_contexts = true

{python_semantic_release-9.11.1 → python_semantic_release-9.12.1/python_semantic_release.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-semantic-release
-Version: 9.11.1
+Version: 9.12.1
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT
@@ -43,13 +43,14 @@ Provides-Extra: test
 Requires-Dist: coverage[toml]~=7.0; extra == "test"
 Requires-Dist: pyyaml~=6.0; extra == "test"
 Requires-Dist: pytest~=8.3; extra == "test"
+Requires-Dist: pytest-clarity~=1.0; extra == "test"
+Requires-Dist: pytest-cov~=5.0; extra == "test"
 Requires-Dist: pytest-env~=1.0; extra == "test"
-Requires-Dist: pytest-xdist~=3.0; extra == "test"
-Requires-Dist: pytest-mock~=3.0; extra == "test"
 Requires-Dist: pytest-lazy-fixtures~=1.1.1; extra == "test"
-Requires-Dist: pytest-cov~=5.0; extra == "test"
+Requires-Dist: pytest-mock~=3.0; extra == "test"
+Requires-Dist: pytest-order~=1.3; extra == "test"
 Requires-Dist: pytest-pretty~=1.2; extra == "test"
-Requires-Dist: pytest-clarity~=1.0; extra == "test"
+Requires-Dist: pytest-xdist~=3.0; extra == "test"
 Requires-Dist: responses~=0.25.0; extra == "test"
 Requires-Dist: requests-mock~=1.10; extra == "test"
 Provides-Extra: dev

{python_semantic_release-9.11.1 → python_semantic_release-9.12.1}/python_semantic_release.egg-info/SOURCES.txt

@@ -3,22 +3,22 @@ LICENSE
 MANIFEST.in
 README.rst
 pyproject.toml
-./semantic_release/data/templates/angular/release_notes.md.j2
-./semantic_release/data/templates/angular/md/.changelog_header.md.j2
-./semantic_release/data/templates/angular/md/.changelog_init.md.j2
-./semantic_release/data/templates/angular/md/.changelog_update.md.j2
-./semantic_release/data/templates/angular/md/.changes.md.j2
-./semantic_release/data/templates/angular/md/.unreleased_changes.md.j2
-./semantic_release/data/templates/angular/md/.versioned_changes.md.j2
+./semantic_release/data/templates/angular/md/.release_notes.md.j2
 ./semantic_release/data/templates/angular/md/CHANGELOG.md.j2
-./semantic_release/data/templates/angular/rst/.changelog_header.rst.j2
-./semantic_release/data/templates/angular/rst/.changelog_init.rst.j2
-./semantic_release/data/templates/angular/rst/.changelog_update.rst.j2
-./semantic_release/data/templates/angular/rst/.changes.rst.j2
-./semantic_release/data/templates/angular/rst/.macros.rst.j2
-./semantic_release/data/templates/angular/rst/.unreleased_changes.rst.j2
-./semantic_release/data/templates/angular/rst/.versioned_changes.rst.j2
+./semantic_release/data/templates/angular/md/.components/changelog_header.md.j2
+./semantic_release/data/templates/angular/md/.components/changelog_init.md.j2
+./semantic_release/data/templates/angular/md/.components/changelog_update.md.j2
+./semantic_release/data/templates/angular/md/.components/changes.md.j2
+./semantic_release/data/templates/angular/md/.components/unreleased_changes.md.j2
+./semantic_release/data/templates/angular/md/.components/versioned_changes.md.j2
 ./semantic_release/data/templates/angular/rst/CHANGELOG.rst.j2
+./semantic_release/data/templates/angular/rst/.components/changelog_header.rst.j2
+./semantic_release/data/templates/angular/rst/.components/changelog_init.rst.j2
+./semantic_release/data/templates/angular/rst/.components/changelog_update.rst.j2
+./semantic_release/data/templates/angular/rst/.components/changes.rst.j2
+./semantic_release/data/templates/angular/rst/.components/macros.rst.j2
+./semantic_release/data/templates/angular/rst/.components/unreleased_changes.rst.j2
+./semantic_release/data/templates/angular/rst/.components/versioned_changes.rst.j2
 docs/Makefile
 docs/algorithm.rst
 docs/changelog_templates.rst
@@ -77,22 +77,22 @@ semantic_release/commit_parser/scipy.py
 semantic_release/commit_parser/tag.py
 semantic_release/commit_parser/token.py
 semantic_release/commit_parser/util.py
-semantic_release/data/templates/angular/release_notes.md.j2
-semantic_release/data/templates/angular/md/.changelog_header.md.j2
-semantic_release/data/templates/angular/md/.changelog_init.md.j2
-semantic_release/data/templates/angular/md/.changelog_update.md.j2
-semantic_release/data/templates/angular/md/.changes.md.j2
-semantic_release/data/templates/angular/md/.unreleased_changes.md.j2
-semantic_release/data/templates/angular/md/.versioned_changes.md.j2
+semantic_release/data/templates/angular/md/.release_notes.md.j2
 semantic_release/data/templates/angular/md/CHANGELOG.md.j2
-semantic_release/data/templates/angular/rst/.changelog_header.rst.j2
-semantic_release/data/templates/angular/rst/.changelog_init.rst.j2
-semantic_release/data/templates/angular/rst/.changelog_update.rst.j2
-semantic_release/data/templates/angular/rst/.changes.rst.j2
-semantic_release/data/templates/angular/rst/.macros.rst.j2
-semantic_release/data/templates/angular/rst/.unreleased_changes.rst.j2
-semantic_release/data/templates/angular/rst/.versioned_changes.rst.j2
+semantic_release/data/templates/angular/md/.components/changelog_header.md.j2
+semantic_release/data/templates/angular/md/.components/changelog_init.md.j2
+semantic_release/data/templates/angular/md/.components/changelog_update.md.j2
+semantic_release/data/templates/angular/md/.components/changes.md.j2
+semantic_release/data/templates/angular/md/.components/unreleased_changes.md.j2
+semantic_release/data/templates/angular/md/.components/versioned_changes.md.j2
 semantic_release/data/templates/angular/rst/CHANGELOG.rst.j2
+semantic_release/data/templates/angular/rst/.components/changelog_header.rst.j2
+semantic_release/data/templates/angular/rst/.components/changelog_init.rst.j2
+semantic_release/data/templates/angular/rst/.components/changelog_update.rst.j2
+semantic_release/data/templates/angular/rst/.components/changes.rst.j2
+semantic_release/data/templates/angular/rst/.components/macros.rst.j2
+semantic_release/data/templates/angular/rst/.components/unreleased_changes.rst.j2
+semantic_release/data/templates/angular/rst/.components/versioned_changes.rst.j2
 semantic_release/hvcs/__init__.py
 semantic_release/hvcs/_base.py
 semantic_release/hvcs/bitbucket.py
@@ -111,20 +111,33 @@ tests/__init__.py
 tests/conftest.py
 tests/const.py
 tests/util.py
-tests/command_line/__init__.py
-tests/command_line/conftest.py
-tests/command_line/test_changelog.py
-tests/command_line/test_generate_config.py
-tests/command_line/test_help.py
-tests/command_line/test_main.py
-tests/command_line/test_publish.py
-tests/command_line/test_version.py
+tests/e2e/__init__.py
+tests/e2e/conftest.py
+tests/e2e/test_help.py
+tests/e2e/test_main.py
+tests/e2e/cmd_changelog/__init__.py
+tests/e2e/cmd_changelog/test_changelog.py
+tests/e2e/cmd_config/__init__.py
+tests/e2e/cmd_config/test_generate_config.py
+tests/e2e/cmd_publish/__init__.py
+tests/e2e/cmd_publish/test_publish.py
+tests/e2e/cmd_version/__init__.py
+tests/e2e/cmd_version/test_version.py
+tests/e2e/cmd_version/test_version_build.py
+tests/e2e/cmd_version/test_version_bump.py
+tests/e2e/cmd_version/test_version_changelog.py
+tests/e2e/cmd_version/test_version_github_actions.py
+tests/e2e/cmd_version/test_version_print.py
+tests/e2e/cmd_version/test_version_release_notes.py
+tests/e2e/cmd_version/test_version_stamp.py
+tests/e2e/cmd_version/test_version_strict.py
 tests/fixtures/__init__.py
 tests/fixtures/commit_parsers.py
 tests/fixtures/example_project.py
 tests/fixtures/git_repo.py
 tests/fixtures/scipy.py
 tests/fixtures/repos/__init__.py
+tests/fixtures/repos/repo_initial_commit.py
 tests/fixtures/repos/git_flow/__init__.py
 tests/fixtures/repos/git_flow/repo_w_2_release_channels.py
 tests/fixtures/repos/git_flow/repo_w_3_release_channels.py
@@ -134,19 +147,17 @@ tests/fixtures/repos/trunk_based_dev/__init__.py
 tests/fixtures/repos/trunk_based_dev/repo_w_no_tags.py
 tests/fixtures/repos/trunk_based_dev/repo_w_prereleases.py
 tests/fixtures/repos/trunk_based_dev/repo_w_tags.py
-tests/scenario/__init__.py
-tests/scenario/test_next_version.py
-tests/scenario/test_release_history.py
-tests/scenario/test_template_render.py
-tests/scenario/test_version_stamp.py
 tests/unit/__init__.py
+tests/unit/conftest.py
 tests/unit/semantic_release/__init__.py
 tests/unit/semantic_release/test_helpers.py
 tests/unit/semantic_release/changelog/__init__.py
 tests/unit/semantic_release/changelog/test_changelog_context.py
 tests/unit/semantic_release/changelog/test_default_changelog.py
+tests/unit/semantic_release/changelog/test_release_history.py
 tests/unit/semantic_release/changelog/test_release_notes.py
 tests/unit/semantic_release/changelog/test_template.py
+tests/unit/semantic_release/changelog/test_template_render.py
 tests/unit/semantic_release/cli/__init__.py
 tests/unit/semantic_release/cli/test_config.py
 tests/unit/semantic_release/cli/test_github_actions_output.py
@@ -158,7 +169,6 @@ tests/unit/semantic_release/commit_parser/test_angular.py
 tests/unit/semantic_release/commit_parser/test_emoji.py
 tests/unit/semantic_release/commit_parser/test_parsed_commit.py
 tests/unit/semantic_release/commit_parser/test_scipy.py
-tests/unit/semantic_release/commit_parser/test_tag.py
 tests/unit/semantic_release/commit_parser/test_util.py
 tests/unit/semantic_release/hvcs/__init__.py
 tests/unit/semantic_release/hvcs/test__base.py

{python_semantic_release-9.11.1 → python_semantic_release-9.12.1}/python_semantic_release.egg-info/requires.txt

@@ -33,12 +33,13 @@ types-requests~=2.32.0
 coverage[toml]~=7.0
 pyyaml~=6.0
 pytest~=8.3
+pytest-clarity~=1.0
+pytest-cov~=5.0
 pytest-env~=1.0
-pytest-xdist~=3.0
-pytest-mock~=3.0
 pytest-lazy-fixtures~=1.1.1
-pytest-cov~=5.0
+pytest-mock~=3.0
+pytest-order~=1.3
 pytest-pretty~=1.2
-pytest-clarity~=1.0
+pytest-xdist~=3.0
 responses~=0.25.0
 requests-mock~=1.10

{python_semantic_release-9.11.1 → python_semantic_release-9.12.1}/semantic_release/__init__.py

@@ -24,7 +24,7 @@ from semantic_release.version import (
     tags_and_versions,
 )
 
-__version__ = "9.11.1"
+__version__ = "9.12.1"
 
 __all__ = [
     "CommitParser",

{python_semantic_release-9.11.1 → python_semantic_release-9.12.1}/semantic_release/changelog/context.py

@@ -82,14 +82,19 @@ def make_changelog_context(
             *hvcs_client.get_changelog_context_filters(),
             read_file,
             convert_md_to_rst,
+            autofit_text_width,
         ),
     )
 
 
 def read_file(filepath: str) -> str:
     try:
+        if not filepath:
+            raise FileNotFoundError("No file path provided")  # noqa: TRY301
+
         with Path(filepath).open(newline=os.linesep) as rfd:
             return rfd.read()
+
     except FileNotFoundError as err:
         logging.warning(err)
         return ""
@@ -105,10 +110,58 @@ def convert_md_to_rst(md_content: str) -> str:
         # Replace markdown bullets with rst bullets
         "bullets": (regexp(r"^(\s*)-(\s)"), r"\1*\2"),
         # Replace markdown inline raw content with rst inline raw content
-        "raw-inline": (regexp(r"(?<=\s)(`[^`]+`)(?![`_])(?=\s|$)"), r"`\1`"),
+        "raw-inline": (regexp(r"(?<=\s)(`[^`]+`)(?![`_])"), r"`\1`"),
     }
 
     for pattern, replacement in replacements.values():
         rst_content = pattern.sub(replacement, rst_content)
 
     return rst_content
+
+
+def autofit_text_width(text: str, maxwidth: int = 100, indent_size: int = 0) -> str:
+    """Format the description text to fit within a specified width"""
+    input_text = text.strip()
+
+    if len(input_text) <= maxwidth:
+        # If the text is already within the maxwidth, return immediately
+        return input_text
+
+    indent = " " * indent_size
+    formatted_description = []
+
+    # Re-format text to fit within the maxwidth
+    for paragraph in input_text.split("\n\n"):
+        formatted_paragraph = []
+
+        # Split the paragraph into words with no empty strings
+        words = list(
+            filter(
+                None, paragraph.replace("\r", "").replace("\n", " ").strip().split(" ")
+            )
+        )
+
+        # Initialize the line for each paragraph
+        line = words[0]
+        next_line = ""
+
+        for word in words[1:]:
+            # Check if the current line + the next word (and a space) will fit within the maxwidth
+            # If it does, then update the current line
+            next_line = f"{line} {word}"
+            if len(next_line) <= maxwidth:
+                line = next_line
+                continue
+
+            # Add the current line to the paragraph and start a new line
+            formatted_paragraph.append(line)
+            line = f"{indent}{word}"
+
+        # Store the last line in the paragraph since it hasn't reached the maxwidth yet
+        formatted_paragraph.append(line)
+
+        #
+        formatted_description.append(str.join("\n", formatted_paragraph))
+
+    # Print the formatted description
+    return str.join("\n\n", formatted_description).strip()

{python_semantic_release-9.11.1 → python_semantic_release-9.12.1}/semantic_release/changelog/release_history.py

@@ -8,6 +8,7 @@ from typing import TYPE_CHECKING, TypedDict
 from git.objects.tag import TagObject
 
 from semantic_release.commit_parser import ParseError
+from semantic_release.enums import LevelBump
 from semantic_release.version.algorithm import tags_and_versions
 
 if TYPE_CHECKING:
@@ -58,20 +59,11 @@ class ReleaseHistory:
         # we place the key-value mapping type_ to ParseResult as before.
         # We do this until we encounter a commit which another tag matches.
 
-        is_commit_released = False
         the_version: Version | None = None
 
         for commit in repo.iter_commits("HEAD", topo_order=True):
-            # mypy will be happy if we make this an explicit string
-            commit_message = str(commit.message)
-
-            parse_result = commit_parser.parse(commit)
-            commit_type = (
-                "unknown" if isinstance(parse_result, ParseError) else parse_result.type
-            )
-            log.debug("commit has type %s", commit_type)
-
-            log.debug("checking if commit %s matches any tags", commit.hexsha)
+            # Determine if we have found another release
+            log.debug("checking if commit %s matches any tags", commit.hexsha[:7])
             t_v = tag_sha_2_version_lookup.get(commit.hexsha, None)
 
             if t_v is None:
@@ -82,7 +74,6 @@ class ReleaseHistory:
                 # we have found the latest commit introduced by this tag
                 # so we create a new Release entry
                 log.debug("found commit %s for tag %s", commit.hexsha, tag.name)
-                is_commit_released = True
 
                 # tag.object is a Commit if the tag is lightweight, otherwise
                 # it is a TagObject with additional metadata about the tag
@@ -110,27 +101,55 @@ class ReleaseHistory:
 
                 released.setdefault(the_version, release)
 
-            if any(pat.match(commit_message) for pat in exclude_commit_patterns):
-                log.debug(
-                    "Skipping excluded commit %s (%s)",
-                    commit.hexsha,
-                    commit_message.replace("\n", " ")[:20],
+            # mypy will be happy if we make this an explicit string
+            commit_message = str(commit.message)
+
+            log.info(
+                "parsing commit [%s] %s",
+                commit.hexsha[:8],
+                commit_message.replace("\n", " ")[:54],
+            )
+            parse_result = commit_parser.parse(commit)
+            commit_type = (
+                "unknown" if isinstance(parse_result, ParseError) else parse_result.type
+            )
+
+            has_exclusion_match = any(
+                pattern.match(commit_message) for pattern in exclude_commit_patterns
+            )
+
+            commit_level_bump = (
+                LevelBump.NO_RELEASE
+                if isinstance(parse_result, ParseError)
+                else parse_result.bump
+            )
+
+            # Skip excluded commits except for any commit causing a version bump
+            # Reasoning: if a commit causes a version bump, and no other commits
+            # are included, then the changelog will be empty. Even if ther was other
+            # commits included, the true reason for a version bump would be missing.
+            if has_exclusion_match and commit_level_bump == LevelBump.NO_RELEASE:
+                log.info(
+                    "Excluding commit [%s] %s",
+                    commit.hexsha[:8],
+                    commit_message.replace("\n", " ")[:50],
                 )
                 continue
 
-            if not is_commit_released:
-                log.debug("adding commit %s to unreleased commits", commit.hexsha)
+            if the_version is None:
+                log.info(
+                    "[Unreleased] adding '%s' commit(%s) to list",
+                    commit.hexsha[:8],
+                    commit_type,
+                )
                 unreleased[commit_type].append(parse_result)
                 continue
 
-            if the_version is None:
-                raise RuntimeError("expected a version to be found")
-
-            log.debug(
-                "adding commit %s with type %s to release section for %s",
-                commit.hexsha,
-                commit_type,
+            log.info(
+                "[%s] adding '%s' commit(%s) to release",
                 the_version,
+                commit_type,
+                commit.hexsha[:8],
             )
 
             released[the_version]["elements"][commit_type].append(parse_result)