python-semantic-release 9.11.0__tar.gz → 9.12.0__tar.gz

{python_semantic_release-9.11.0/python_semantic_release.egg-info → python_semantic_release-9.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-semantic-release
-Version: 9.11.0
+Version: 9.12.0
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT

{python_semantic_release-9.11.0 → python_semantic_release-9.12.0}/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.0
+    - uses: python-semantic-release/python-semantic-release@v9.12.0
       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.0
+            uses: python-semantic-release/python-semantic-release@v9.12.0
             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.0
+    uses: python-semantic-release/python-semantic-release@v9.12.0
     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.0
+     uses: python-semantic-release/python-semantic-release@v9.12.0
      with:
        directory: ./project1
        github_token: ${{ secrets.GITHUB_TOKEN }}
 
    - name: Release Project 2
-     uses: python-semantic-release/python-semantic-release@v9.11.0
+     uses: python-semantic-release/python-semantic-release@v9.12.0
      with:
        directory: ./project2
        github_token: ${{ secrets.GITHUB_TOKEN }}

{python_semantic_release-9.11.0 → python_semantic_release-9.12.0}/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            ✅       ✅      ✅      ✅

{python_semantic_release-9.11.0 → python_semantic_release-9.12.0}/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.0 → python_semantic_release-9.12.0}/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.0 → python_semantic_release-9.12.0}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-semantic-release"
-version = "9.11.0"
+version = "9.12.0"
 description = "Automatic Semantic Versioning for Python projects"
 requires-python = ">=3.8"
 license = { text = "MIT" }

{python_semantic_release-9.11.0 → python_semantic_release-9.12.0/python_semantic_release.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-semantic-release
-Version: 9.11.0
+Version: 9.12.0
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT

{python_semantic_release-9.11.0 → python_semantic_release-9.12.0}/python_semantic_release.egg-info/SOURCES.txt

@@ -158,7 +158,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.0 → python_semantic_release-9.12.0}/semantic_release/__init__.py

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

{python_semantic_release-9.11.0 → python_semantic_release-9.12.0}/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 ""
@@ -112,3 +117,51 @@ def convert_md_to_rst(md_content: str) -> str:
         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.0 → python_semantic_release-9.12.0}/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)

{python_semantic_release-9.11.0 → python_semantic_release-9.12.0}/semantic_release/changelog/template.py

@@ -92,7 +92,6 @@ class ComplexDirectorySandboxedEnvironment(SandboxedEnvironment):
         return str(PurePosixPath(parent).parent / template)
 
 
-# pylint: disable=redefined-outer-name
 def recursive_render(
     template_dir: Path,
     environment: Environment,
@@ -103,13 +102,8 @@ def recursive_render(
         (Path(root), file)
         for root, _, files in os.walk(template_dir)
         for file in files
-        # we slice relpath.parts[1:] to allow the top-level
-        # template folder to have a dot prefix.
-        # e.g. to permit ".github/psr-templates" to contain the templates,
-        # rather than enforcing a top-level, non-hidden directory
         if not any(
-            elem.startswith(".")
-            for elem in Path(root).relative_to(template_dir).parts[1:]
+            elem.startswith(".") for elem in Path(root).relative_to(template_dir).parts
         )
         and not file.startswith(".")
     ):

{python_semantic_release-9.11.0 → python_semantic_release-9.12.0}/semantic_release/cli/changelog_writer.py

@@ -12,6 +12,7 @@ from importlib_resources import files
 import semantic_release
 from semantic_release.changelog.context import (
     ReleaseNotesContext,
+    autofit_text_width,
     make_changelog_context,
 )
 from semantic_release.changelog.template import environment, recursive_render
@@ -245,7 +246,7 @@ def generate_release_notes(
         hvcs_type=hvcs_client.__class__.__name__.lower(),
         version=release["version"],
         release=release,
-        filters=(*hvcs_client.get_changelog_context_filters(),),
+        filters=(*hvcs_client.get_changelog_context_filters(), autofit_text_width),
     ).bind_to_environment(
         # Use a new, non-configurable environment for release notes -
         # not user-configurable at the moment

{python_semantic_release-9.11.0 → python_semantic_release-9.12.0}/semantic_release/cli/commands/main.py

@@ -19,7 +19,7 @@ from semantic_release.cli.util import rprint
 #     pass
 
 
-FORMAT = "[%(name)s] %(levelname)s %(module)s.%(funcName)s: %(message)s"
+FORMAT = "[%(module)s.%(funcName)s] %(message)s"
 
 
 class Cli(click.MultiCommand):

{python_semantic_release-9.11.0 → python_semantic_release-9.12.0}/semantic_release/cli/config.py

@@ -370,6 +370,22 @@ class RawConfig(BaseModel):
             )
         return found_path
 
+    @field_validator("commit_parser", mode="after")
+    @classmethod
+    def tag_commit_parser_deprecation_warning(cls, val: str) -> str:
+        if val == "tag":
+            log.warning(
+                str.join(
+                    " ",
+                    [
+                        "The legacy 'tag' parser is deprecated and will be removed in v11.",
+                        "Recommend swapping to our emoji parser (higher-compatibility)",
+                        "or switch to another supported parser.",
+                    ],
+                )
+            )
+        return val
+
     @field_validator("build_command_env", mode="after")
     @classmethod
     def remove_whitespace(cls, val: list[str]) -> list[str]:

{python_semantic_release-9.11.0 → python_semantic_release-9.12.0}/semantic_release/commit_parser/angular.py

@@ -19,11 +19,11 @@ from semantic_release.enums import LevelBump
 if TYPE_CHECKING:
     from git.objects.commit import Commit
 
-log = logging.getLogger(__name__)
+logger = logging.getLogger(__name__)
 
 
 def _logged_parse_error(commit: Commit, error: str) -> ParseError:
-    log.debug(error)
+    logger.debug(error)
     return ParseError(commit, error=error)
 
 
@@ -35,7 +35,7 @@ LONG_TYPE_NAMES = {
     "chore": "chores",
     "docs": "documentation",
     "feat": "features",
-    "fix": "fixes",
+    "fix": "bug fixes",
     "perf": "performance improvements",
     "refactor": "refactoring",
     "style": "code style",
@@ -131,12 +131,15 @@ class AngularCommitParser(CommitParser[ParseResult, AngularParserOptions]):
             level_bump = LevelBump.PATCH
         else:
             level_bump = self.options.default_bump_level
-            log.debug(
+            logger.debug(
                 "commit %s introduces a level bump of %s due to the default_bump_level",
-                commit.hexsha,
+                commit.hexsha[:8],
                 level_bump,
             )
-        log.debug("commit %s introduces a %s level_bump", commit.hexsha, level_bump)
+
+        logger.debug(
+            "commit %s introduces a %s level_bump", commit.hexsha[:8], level_bump
+        )
 
         return ParsedCommit(
             bump=level_bump,

{python_semantic_release-9.11.0 → python_semantic_release-9.12.0}/semantic_release/commit_parser/emoji.py

@@ -89,6 +89,17 @@ class EmojiCommitParser(CommitParser[ParseResult, EmojiParserOptions]):
             level_bump = LevelBump.MINOR
         elif primary_emoji in self.options.patch_tags:
             level_bump = LevelBump.PATCH
+        else:
+            level_bump = self.options.default_bump_level
+            logger.debug(
+                "commit %s introduces a level bump of %s due to the default_bump_level",
+                commit.hexsha[:8],
+                level_bump,
+            )
+
+        logger.debug(
+            "commit %s introduces a %s level_bump", commit.hexsha[:8], level_bump
+        )
 
         # All emojis will remain part of the returned description
         descriptions = parse_paragraphs(message)

{python_semantic_release-9.11.0 → python_semantic_release-9.12.0}/semantic_release/commit_parser/scipy.py

@@ -59,11 +59,11 @@ from semantic_release.enums import LevelBump
 if TYPE_CHECKING:
     from git.objects.commit import Commit
 
-log = logging.getLogger(__name__)
+logger = logging.getLogger(__name__)
 
 
 def _logged_parse_error(commit: Commit, error: str) -> ParseError:
-    log.debug(error)
+    logger.debug(error)
     return ParseError(commit, error=error)
 
 
@@ -165,17 +165,19 @@ class ScipyCommitParser(CommitParser[ParseResult, ScipyParserOptions]):
                 level_bump = self.options.tag_to_level.get(
                     tag, self.options.default_level_bump
                 )
-                log.debug(
-                    "commit %s introduces a %s level_bump", commit.hexsha, level_bump
+                logger.debug(
+                    "commit %s introduces a %s level_bump",
+                    commit.hexsha[:8],
+                    level_bump,
                 )
                 break
         else:
             # some commits may not have a tag, e.g. if they belong to a PR that
             # wasn't squashed (for maintainability) ignore them
             section, level_bump = "None", self.options.default_level_bump
-            log.debug(
-                "commit %s introduces a level bump of %s due to the default_bump_level",
-                commit.hexsha,
+            logger.debug(
+                "commit %s introduces a level bump of %s due to the default bump level",
+                commit.hexsha[:8],
                 level_bump,
             )
 
@@ -185,9 +187,9 @@ class ScipyCommitParser(CommitParser[ParseResult, ScipyParserOptions]):
         ]
         if migration_instructions:
             level_bump = LevelBump.MAJOR
-            log.debug(
-                "commit %s upgraded to a %s level_bump due to migration_instructions",
-                commit.hexsha,
+            logger.debug(
+                "commit %s upgraded to a %s level bump due to included migration instructions",
+                commit.hexsha[:8],
                 level_bump,
             )
 

{python_semantic_release-9.11.0 → python_semantic_release-9.12.0}/semantic_release/commit_parser/tag.py

@@ -11,7 +11,7 @@ from semantic_release.commit_parser.token import ParsedCommit, ParseError, Parse
 from semantic_release.commit_parser.util import breaking_re, parse_paragraphs
 from semantic_release.enums import LevelBump
 
-log = logging.getLogger(__name__)
+logger = logging.getLogger(__name__)
 
 re_parser = re.compile(r"(?P<subject>[^\n]+)" + r"(:?\n\n(?P<text>.+))?", re.DOTALL)
 
@@ -23,7 +23,7 @@ class TagParserOptions(ParserOptions):
 
 
 def _logged_parse_error(commit: Commit, error: str) -> ParseError:
-    log.debug(error)
+    logger.debug(error)
     return ParseError(commit, error=error)
 
 
@@ -87,12 +87,16 @@ class TagCommitParser(CommitParser[ParseResult, TagParserOptions]):
         if breaking_descriptions:
             level = "breaking"
             level_bump = LevelBump.MAJOR
-            log.debug(
-                "commit %s upgraded to a %s level_bump due to breaking_descriptions",
-                commit.hexsha,
+            logger.debug(
+                "commit %s upgraded to a %s level_bump due to included breaking descriptions",
+                commit.hexsha[:8],
                 level_bump,
             )
 
+        logger.debug(
+            "commit %s introduces a %s level_bump", commit.hexsha[:8], level_bump
+        )
+
         return ParsedCommit(
             bump=level_bump,
             type=level,