python-semantic-release 9.12.2__py3-none-any.whl → 9.13.0__py3-none-any.whl

{python_semantic_release-9.12.2.dist-info → python_semantic_release-9.13.0.dist-info}/METADATA

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

{python_semantic_release-9.12.2.dist-info → python_semantic_release-9.13.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-semantic_release/__init__.py,sha256=DhNOjxINWOV6dyjCQmaizz8XX9v6ReMVyZLlzmMRtiw,1229
+semantic_release/__init__.py,sha256=HkSV-d4oTywSXoJB6atMrEkQnimWPdJJGqSSrFeYjQQ,1229
 semantic_release/__main__.py,sha256=kuotDU7aFKrCBeAJUPWrbIxgJWAmrXUMnztCqWMDMPY,1292
 semantic_release/const.py,sha256=Z1o2QNh60wSLeF-_1TemMBjU3ZXbV0XghnUFsbTVfOs,831
 semantic_release/enums.py,sha256=D5B_reQGGKQQT22HO5PUtvn2Bok3fkht6TfJtXkmAUg,1020
@@ -26,26 +26,27 @@ semantic_release/cli/commands/publish.py,sha256=SZQlIewvqyIC14dkIIVVFetE0tPsKbO1
 semantic_release/cli/commands/version.py,sha256=PKNoP_b8puzcScKkQEbeB3DviJv49cQ-vjq6v25nG9Q,23931
 semantic_release/commit_parser/__init__.py,sha256=cv5HFBdw7OJd4Laj4Ex8ZZ5Tml8GwXgQcXW6Pasr2Ao,615
 semantic_release/commit_parser/_base.py,sha256=t-Z9ALgAe7aZpYXz1mk3Fe-uAvipgKdNrq4Okg_WW9c,3026
-semantic_release/commit_parser/angular.py,sha256=aq8UxCqwernLX2lEGp3Y9OMYMVt_to9rJLEjcscWF34,5911
-semantic_release/commit_parser/emoji.py,sha256=foN7wVDW1Lv7A_cR4mq4X2aas17IEwTgQ8xjUXduN8k,3830
-semantic_release/commit_parser/scipy.py,sha256=p7Ox0GJGtJ3jKroDDW55Iu1Ma2089VegESRcagwDwJw,6028
+semantic_release/commit_parser/angular.py,sha256=a1AmgstkclzJnRWqSsF4cuO8awuOJe7VAG__1W7WF7U,7276
+semantic_release/commit_parser/emoji.py,sha256=4OQ5yyHBNC-pA7d6KP_pMjKxutwVaBvO_ydqCT1KtJA,5849
+semantic_release/commit_parser/scipy.py,sha256=u_5OWOeM2V7_jZzYfEicKqx0GJBsAqIOfzRX_4cmOqk,3973
 semantic_release/commit_parser/tag.py,sha256=4uwIKBqUM2SE6UTGIw-a7B6Jg1OONXmGwXsTyL3yZBA,3490
-semantic_release/commit_parser/token.py,sha256=BB4ZCyt753CCaBFF95cQ4sFm6Au96wpO0YyTAWdcOvE,1609
-semantic_release/commit_parser/util.py,sha256=vLcVDErZrExM55jMffos0hyMbNVQoJ-PeeVDG1Ej51I,730
+semantic_release/commit_parser/token.py,sha256=-C1ZKG7pdbcGT2nc3-L2APLUUDGTXkbDeNi5mvvUwjk,2621
+semantic_release/commit_parser/util.py,sha256=b9lud_FBjsmimLrvILf_NXvZ2wg8JPDmA364hcfM6is,1710
 semantic_release/data/templates/angular/md/.release_notes.md.j2,sha256=bJeaCDzbva8ntefPPeAS3YD0GXkZv-j0_fIbVmnAKbQ,52
-semantic_release/data/templates/angular/md/CHANGELOG.md.j2,sha256=tFFPsT-EsZHAuSS6xVEAN_Iofu6c-psFoqdyFn_NW2k,838
+semantic_release/data/templates/angular/md/CHANGELOG.md.j2,sha256=zsf5C75jBP2JUdl_7dJvEXgPURvFp6GxPKGRelqLghM,854
 semantic_release/data/templates/angular/md/.components/changelog_header.md.j2,sha256=qNxTuSr59CV_yyimVU_RYp5azCnK0l6nJ03Zf0u5Ugg,166
 semantic_release/data/templates/angular/md/.components/changelog_init.md.j2,sha256=d3tS_nCe_ttNQRGl8Jan4H42iJ8hKu03HrfdEdGAh5M,599
 semantic_release/data/templates/angular/md/.components/changelog_update.md.j2,sha256=JhXF-vYlqd4qNI8rO2Hte3Jbemo17wdeZ7w3G2nwjus,2384
-semantic_release/data/templates/angular/md/.components/changes.md.j2,sha256=oC2amekjxsNjgj0BkVzs6ANswxntOi3ItlQd9VtbVm8,339
+semantic_release/data/templates/angular/md/.components/changes.md.j2,sha256=qA190vxbADim4M1b2f-oWF4uWT7Vx8ToSjKrRkPeJfA,1638
+semantic_release/data/templates/angular/md/.components/macros.md.j2,sha256=cUrl4tqjhR6Ur-gl_gHsuRz1DVU7X_-0QYnswahoTm0,1709
 semantic_release/data/templates/angular/md/.components/unreleased_changes.md.j2,sha256=HRLj6cyRfPZXC0s-0Av6s0Gp3jKxWg9AIEtIXBVqJuY,177
 semantic_release/data/templates/angular/md/.components/versioned_changes.md.j2,sha256=2Hky2mBrC4jltz3mvaiPDD0KQP0ELe5Ag75HgaLpaIE,257
 semantic_release/data/templates/angular/rst/CHANGELOG.rst.j2,sha256=OQPAKgqTnYGXFyDTm8hwYsMWXfi_z8I5Fsgtw09sWBQ,840
 semantic_release/data/templates/angular/rst/.components/changelog_header.rst.j2,sha256=c9xN1SEYLFwMvPYXYKt-ZbYPn2-Ss0V7zepEtFFj3Os,200
 semantic_release/data/templates/angular/rst/.components/changelog_init.rst.j2,sha256=dOICVsTMVLewBDC9QMHhX6Ub9rUFlBAzHOGvsFtNzYY,596
 semantic_release/data/templates/angular/rst/.components/changelog_update.rst.j2,sha256=L44PJyCb1xge2wC2-w9cAPCLoJDFVIsm8BnZeQOzg94,2381
-semantic_release/data/templates/angular/rst/.components/changes.rst.j2,sha256=bF9fv3ufFIsAmcCI1GN9eind5Oc3YB1QPw7BFCPtdS8,938
-semantic_release/data/templates/angular/rst/.components/macros.rst.j2,sha256=jTrUMX5TBpUFP5oo2UZTPB-88hX7NMr-LAuddIJdmhw,551
+semantic_release/data/templates/angular/rst/.components/changes.rst.j2,sha256=0JDnsFghFqHezOim9IuQhlVig5mHBKf8Aq7_Y9M2UQE,2852
+semantic_release/data/templates/angular/rst/.components/macros.rst.j2,sha256=C_5V80wQu-uCLE_Qp3ACwGS-4jQDGc7NmKaDi3C6m1s,2774
 semantic_release/data/templates/angular/rst/.components/unreleased_changes.rst.j2,sha256=ARBhc1ZpKwehGKDvOMqukmN59mTJiHzHsS7rOfKYCt8,202
 semantic_release/data/templates/angular/rst/.components/versioned_changes.rst.j2,sha256=NZfn1W14QochiAJ43oNKmcrCn_vgfbkKtvOTAw1jEc8,530
 semantic_release/hvcs/__init__.py,sha256=JwoaLOF-12L-OBo_9-tOXXhdiHKeVungA9865to2oZk,494
@@ -62,10 +63,10 @@ semantic_release/version/algorithm.py,sha256=ofx_bIWq6ptJVr-ekI11IzxzDEctDKFiVwa
 semantic_release/version/declaration.py,sha256=f6Ld7hIhrqvDrRBapJHr-KDimuyo-4IG8009Zu9BIgU,7357
 semantic_release/version/translator.py,sha256=P1noIsVBn8u6zNOFjG0xKYOWapxqf_PHSMvMeLJ9kXg,3050
 semantic_release/version/version.py,sha256=6PCtSbLP88U1daoxnCwHc--YguZo4waGNLqJ5JfeczE,14175
-python_semantic_release-9.12.2.dist-info/AUTHORS.rst,sha256=XOReVvpymEFUPsS2QPH97jlfJBVrxwS2eu8-jVAe4gk,230
-python_semantic_release-9.12.2.dist-info/LICENSE,sha256=NE85nszX252sdQdu0xgS9qwfYES0k8qS6gW3uO4jRGE,1083
-python_semantic_release-9.12.2.dist-info/METADATA,sha256=ONiKGfUl4d-OGkLjgRYVvT-TG-6QYTxvGGmOhi-pvFY,3571
-python_semantic_release-9.12.2.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
-python_semantic_release-9.12.2.dist-info/entry_points.txt,sha256=r2Jql3GTQyugQnvf34l2eXk1O_Qx6llR_xixG1ZWgD0,105
-python_semantic_release-9.12.2.dist-info/top_level.txt,sha256=qYA24nyg3eP-ti5UW7Vuj2aXVmM0wqVHx4mREdRZNAA,17
-python_semantic_release-9.12.2.dist-info/RECORD,,
+python_semantic_release-9.13.0.dist-info/AUTHORS.rst,sha256=XOReVvpymEFUPsS2QPH97jlfJBVrxwS2eu8-jVAe4gk,230
+python_semantic_release-9.13.0.dist-info/LICENSE,sha256=NE85nszX252sdQdu0xgS9qwfYES0k8qS6gW3uO4jRGE,1083
+python_semantic_release-9.13.0.dist-info/METADATA,sha256=aFjXFtGi0j7sN3G2CfwdCPBGENzFlgkU9a2oDp_2Jeo,3571
+python_semantic_release-9.13.0.dist-info/WHEEL,sha256=bFJAMchF8aTQGUgMZzHJyDDMPTO3ToJ7x23SLJa1SVo,92
+python_semantic_release-9.13.0.dist-info/entry_points.txt,sha256=r2Jql3GTQyugQnvf34l2eXk1O_Qx6llR_xixG1ZWgD0,105
+python_semantic_release-9.13.0.dist-info/top_level.txt,sha256=qYA24nyg3eP-ti5UW7Vuj2aXVmM0wqVHx4mREdRZNAA,17
+python_semantic_release-9.13.0.dist-info/RECORD,,

{python_semantic_release-9.12.2.dist-info → python_semantic_release-9.13.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.44.0)
+Generator: bdist_wheel (0.45.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

semantic_release/__init__.py

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

semantic_release/commit_parser/angular.py

@@ -8,19 +8,26 @@ from __future__ import annotations
 import logging
 import re
 from functools import reduce
+from itertools import zip_longest
 from re import compile as regexp
 from typing import TYPE_CHECKING, Tuple
 
 from pydantic.dataclasses import dataclass
 
 from semantic_release.commit_parser._base import CommitParser, ParserOptions
-from semantic_release.commit_parser.token import ParsedCommit, ParseError, ParseResult
+from semantic_release.commit_parser.token import (
+    ParsedCommit,
+    ParsedMessageResult,
+    ParseError,
+    ParseResult,
+)
 from semantic_release.commit_parser.util import breaking_re, parse_paragraphs
 from semantic_release.enums import LevelBump
 
 if TYPE_CHECKING:
     from git.objects.commit import Commit
 
+
 logger = logging.getLogger(__name__)
 
 
@@ -65,11 +72,16 @@ class AngularParserOptions(ParserOptions):
     default_bump_level: LevelBump = LevelBump.NO_RELEASE
 
     def __post_init__(self) -> None:
-        self.tag_to_level = {tag: self.default_bump_level for tag in self.allowed_tags}
-        for tag in self.patch_tags:
-            self.tag_to_level[tag] = LevelBump.PATCH
-        for tag in self.minor_tags:
-            self.tag_to_level[tag] = LevelBump.MINOR
+        self.tag_to_level: dict[str, LevelBump] = dict(
+            [
+                # we have to do a type ignore as zip_longest provides a type that is not specific enough
+                # for our expected output. Due to the empty second array, we know the first is always longest
+                # and that means no values in the first entry of the tuples will ever be a LevelBump.
+                *zip_longest(self.allowed_tags, (), fillvalue=self.default_bump_level),  # type: ignore[list-item]
+                *zip_longest(self.patch_tags, (), fillvalue=LevelBump.PATCH),  # type: ignore[list-item]
+                *zip_longest(self.minor_tags, (), fillvalue=LevelBump.MINOR),  # type: ignore[list-item]
+            ]
+        )
 
 
 class AngularCommitParser(CommitParser[ParseResult, AngularParserOptions]):
@@ -98,6 +110,10 @@ class AngularCommitParser(CommitParser[ParseResult, AngularParserOptions]):
             ),
             flags=re.DOTALL,
         )
+        # GitHub & Gitea use (#123), GitLab uses (!123), and BitBucket uses (pull request #123)
+        self.mr_selector = regexp(
+            r"[\t ]+\((?:pull request )?(?P<mr_number>[#!]\d+)\)[\t ]*$"
+        )
 
     @staticmethod
     def get_default_options() -> AngularParserOptions:
@@ -114,27 +130,23 @@ class AngularCommitParser(CommitParser[ParseResult, AngularParserOptions]):
         accumulator["descriptions"].append(text)
         return accumulator
 
-    # Maybe this can be cached as an optimization, similar to how
-    # mypy/pytest use their own caching directories, for very large commit
-    # histories?
-    # The problem is the cache likely won't be present in CI environments
-    def parse(self, commit: Commit) -> ParseResult:
-        """
-        Attempt to parse the commit message with a regular expression into a
-        ParseResult
-        """
-        message = str(commit.message)
-        parsed = self.re_parser.match(message)
-        if not parsed:
-            return _logged_parse_error(
-                commit, f"Unable to parse commit message: {message}"
-            )
+    def parse_message(self, message: str) -> ParsedMessageResult | None:
+        if not (parsed := self.re_parser.match(message)):
+            return None
+
         parsed_break = parsed.group("break")
         parsed_scope = parsed.group("scope")
         parsed_subject = parsed.group("subject")
         parsed_text = parsed.group("text")
         parsed_type = parsed.group("type")
 
+        linked_merge_request = ""
+        if mr_match := self.mr_selector.search(parsed_subject):
+            linked_merge_request = mr_match.group("mr_number")
+            # TODO: breaking change v10, removes PR number from subject/descriptions
+            # expects changelog template to format the line accordingly
+            # parsed_subject = self.pr_selector.sub("", parsed_subject).strip()
+
         body_components: dict[str, list[str]] = reduce(
             self.commit_body_components_separator,
             [
@@ -157,19 +169,34 @@ class AngularCommitParser(CommitParser[ParseResult, AngularParserOptions]):
             )
         )
 
-        # TODO: remove in the future
-        if level_bump == LevelBump.MAJOR:
-            parsed_type = "breaking"
+        return ParsedMessageResult(
+            bump=level_bump,
+            type=parsed_type,
+            category=LONG_TYPE_NAMES.get(parsed_type, parsed_type),
+            scope=parsed_scope,
+            descriptions=tuple(body_components["descriptions"]),
+            breaking_descriptions=tuple(body_components["breaking_descriptions"]),
+            linked_merge_request=linked_merge_request,
+        )
+
+    # Maybe this can be cached as an optimization, similar to how
+    # mypy/pytest use their own caching directories, for very large commit
+    # histories?
+    # The problem is the cache likely won't be present in CI environments
+    def parse(self, commit: Commit) -> ParseResult:
+        """
+        Attempt to parse the commit message with a regular expression into a
+        ParseResult
+        """
+        if not (pmsg_result := self.parse_message(str(commit.message))):
+            return _logged_parse_error(
+                commit, f"Unable to parse commit message: {commit.message!r}"
+            )
 
         logger.debug(
-            "commit %s introduces a %s level_bump", commit.hexsha[:8], level_bump
+            "commit %s introduces a %s level_bump",
+            commit.hexsha[:8],
+            pmsg_result.bump,
         )
 
-        return ParsedCommit(
-            bump=level_bump,
-            type=LONG_TYPE_NAMES.get(parsed_type, parsed_type),
-            scope=parsed_scope,
-            descriptions=body_components["descriptions"],
-            breaking_descriptions=body_components["breaking_descriptions"],
-            commit=commit,
-        )
+        return ParsedCommit.from_parsed_message_result(commit, pmsg_result)

semantic_release/commit_parser/emoji.py

@@ -1,13 +1,21 @@
 """Commit parser which looks for emojis to determine the type of commit"""
 
+from __future__ import annotations
+
 import logging
+from itertools import zip_longest
+from re import compile as regexp
 from typing import Tuple
 
 from git.objects.commit import Commit
 from pydantic.dataclasses import dataclass
 
 from semantic_release.commit_parser._base import CommitParser, ParserOptions
-from semantic_release.commit_parser.token import ParsedCommit, ParseResult
+from semantic_release.commit_parser.token import (
+    ParsedCommit,
+    ParsedMessageResult,
+    ParseResult,
+)
 from semantic_release.commit_parser.util import parse_paragraphs
 from semantic_release.enums import LevelBump
 
@@ -41,8 +49,26 @@ class EmojiParserOptions(ParserOptions):
         ":robot:",
         ":green_apple:",
     )
+    allowed_tags: Tuple[str, ...] = (
+        *major_tags,
+        *minor_tags,
+        *patch_tags,
+    )
     default_bump_level: LevelBump = LevelBump.NO_RELEASE
 
+    def __post_init__(self) -> None:
+        self.tag_to_level: dict[str, LevelBump] = dict(
+            [
+                # we have to do a type ignore as zip_longest provides a type that is not specific enough
+                # for our expected output. Due to the empty second array, we know the first is always longest
+                # and that means no values in the first entry of the tuples will ever be a LevelBump.
+                *zip_longest(self.allowed_tags, (), fillvalue=self.default_bump_level),  # type: ignore[list-item]
+                *zip_longest(self.patch_tags, (), fillvalue=LevelBump.PATCH),  # type: ignore[list-item]
+                *zip_longest(self.minor_tags, (), fillvalue=LevelBump.MINOR),  # type: ignore[list-item]
+                *zip_longest(self.major_tags, (), fillvalue=LevelBump.MAJOR),  # type: ignore[list-item]
+            ]
+        )
+
 
 class EmojiCommitParser(CommitParser[ParseResult, EmojiParserOptions]):
     """
@@ -60,56 +86,77 @@ class EmojiCommitParser(CommitParser[ParseResult, EmojiParserOptions]):
     # TODO: Deprecate in lieu of get_default_options()
     parser_options = EmojiParserOptions
 
+    def __init__(self, options: EmojiParserOptions | None = None) -> None:
+        super().__init__(options)
+        prcedence_order_regex = str.join(
+            "|",
+            [
+                *self.options.major_tags,
+                *self.options.minor_tags,
+                *self.options.patch_tags,
+            ],
+        )
+        self.emoji_selector = regexp(r"(?P<type>%s)" % prcedence_order_regex)
+
+        # GitHub & Gitea use (#123), GitLab uses (!123), and BitBucket uses (pull request #123)
+        self.mr_selector = regexp(
+            r"[\t ]+\((?:pull request )?(?P<mr_number>[#!]\d+)\)[\t ]*$"
+        )
+
     @staticmethod
     def get_default_options() -> EmojiParserOptions:
         return EmojiParserOptions()
 
-    def parse(self, commit: Commit) -> ParseResult:
-        all_emojis = (
-            self.options.major_tags + self.options.minor_tags + self.options.patch_tags
+    def parse_message(self, message: str) -> ParsedMessageResult:
+        subject = message.split("\n", maxsplit=1)[0]
+
+        linked_merge_request = ""
+        if mr_match := self.mr_selector.search(subject):
+            linked_merge_request = mr_match.group("mr_number")
+            # TODO: breaking change v10, removes PR number from subject/descriptions
+            # expects changelog template to format the line accordingly
+            # subject = self.mr_selector.sub("", subject).strip()
+
+        # Search for emoji of the highest importance in the subject
+        primary_emoji = (
+            match.group("type")
+            if (match := self.emoji_selector.search(subject))
+            else "Other"
         )
 
-        message = str(commit.message)
-        subject = message.split("\n")[0]
-
-        # Loop over emojis from most important to least important
-        # Therefore, we find the highest level emoji first
-        primary_emoji = "Other"
-        for emoji in all_emojis:
-            if emoji in subject:
-                primary_emoji = emoji
-                break
-        logger.debug("Selected %s as the primary emoji", primary_emoji)
-
-        # Find which level this commit was from
-        level_bump = LevelBump.NO_RELEASE
-        if primary_emoji in self.options.major_tags:
-            level_bump = LevelBump.MAJOR
-        elif primary_emoji in self.options.minor_tags:
-            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
+        level_bump = self.options.tag_to_level.get(
+            primary_emoji, self.options.default_bump_level
         )
 
         # All emojis will remain part of the returned description
-        descriptions = parse_paragraphs(message)
-        return ParsedCommit(
+        descriptions = tuple(parse_paragraphs(message))
+        return ParsedMessageResult(
             bump=level_bump,
             type=primary_emoji,
-            scope="",
+            category=primary_emoji,
+            scope="",  # TODO: add scope support
+            # TODO: breaking change v10, removes breaking change footers from descriptions
+            # descriptions=(
+            #     descriptions[:1] if level_bump is LevelBump.MAJOR else descriptions
+            # )
             descriptions=descriptions,
             breaking_descriptions=(
-                descriptions[1:] if level_bump is LevelBump.MAJOR else []
+                descriptions[1:] if level_bump is LevelBump.MAJOR else ()
             ),
-            commit=commit,
+            linked_merge_request=linked_merge_request,
+        )
+
+    def parse(self, commit: Commit) -> ParseResult:
+        """
+        Attempt to parse the commit message with a regular expression into a
+        ParseResult
+        """
+        pmsg_result = self.parse_message(str(commit.message))
+
+        logger.debug(
+            "commit %s introduces a %s level_bump",
+            commit.hexsha[:8],
+            pmsg_result.bump,
         )
+
+        return ParsedCommit.from_parsed_message_result(commit, pmsg_result)

semantic_release/commit_parser/scipy.py

@@ -47,13 +47,18 @@ Supported Changelog Sections::
 from __future__ import annotations
 
 import logging
-import re
 from typing import TYPE_CHECKING, Tuple
 
 from pydantic.dataclasses import dataclass
 
-from semantic_release.commit_parser._base import CommitParser, ParserOptions
-from semantic_release.commit_parser.token import ParsedCommit, ParseError, ParseResult
+from semantic_release.commit_parser.angular import (
+    AngularCommitParser,
+    AngularParserOptions,
+)
+from semantic_release.commit_parser.token import (
+    ParsedMessageResult,
+    ParseError,
+)
 from semantic_release.enums import LevelBump
 
 if TYPE_CHECKING:
@@ -86,11 +91,16 @@ tag_to_section = {
     "TEST": "None",
 }
 
-_COMMIT_FILTER = "|".join(tag_to_section)
-
 
 @dataclass
-class ScipyParserOptions(ParserOptions):
+class ScipyParserOptions(AngularParserOptions):
+    """
+    Options dataclass for ScipyCommitParser
+
+    Scipy-style commit messages follow the same format as Angular-style commit
+    just with different tag names.
+    """
+
     major_tags: Tuple[str, ...] = ("API",)
     minor_tags: Tuple[str, ...] = ("DEP", "DEV", "ENH", "REV", "FEAT")
     patch_tags: Tuple[str, ...] = ("BLD", "BUG", "MAINT")
@@ -105,19 +115,18 @@ class ScipyParserOptions(ParserOptions):
         "REL",
         "TEST",
     )
+    # TODO: breaking v10, make consistent with AngularParserOptions
     default_level_bump: LevelBump = LevelBump.NO_RELEASE
 
     def __post_init__(self) -> None:
-        self.tag_to_level = {tag: LevelBump.NO_RELEASE for tag in self.allowed_tags}
-        for tag in self.patch_tags:
-            self.tag_to_level[tag] = LevelBump.PATCH
-        for tag in self.minor_tags:
-            self.tag_to_level[tag] = LevelBump.MINOR
+        # TODO: breaking v10, remove as the name is now consistent
+        self.default_bump_level = self.default_level_bump
+        super().__post_init__()
         for tag in self.major_tags:
             self.tag_to_level[tag] = LevelBump.MAJOR
 
 
-class ScipyCommitParser(CommitParser[ParseResult, ScipyParserOptions]):
+class ScipyCommitParser(AngularCommitParser):
     """Parser for scipy-style commit messages"""
 
     # TODO: Deprecate in lieu of get_default_options()
@@ -125,79 +134,19 @@ class ScipyCommitParser(CommitParser[ParseResult, ScipyParserOptions]):
 
     def __init__(self, options: ScipyParserOptions | None = None) -> None:
         super().__init__(options)
-        self.re_parser = re.compile(
-            rf"(?P<tag>{_COMMIT_FILTER})?"
-            r"(?:\((?P<scope>[^\n]+)\))?"
-            r":? "
-            r"(?P<subject>[^\n]+):?"
-            r"(\n\n(?P<text>.*))?",
-            re.DOTALL,
-        )
 
     @staticmethod
     def get_default_options() -> ScipyParserOptions:
         return ScipyParserOptions()
 
-    def parse(self, commit: Commit) -> ParseResult:
-        message = str(commit.message)
-        parsed = self.re_parser.match(message)
-
-        if not parsed:
-            return _logged_parse_error(
-                commit, f"Unable to parse the given commit message: {message}"
+    def parse_message(self, message: str) -> ParsedMessageResult | None:
+        return (
+            None
+            if not (pmsg_result := super().parse_message(message))
+            else ParsedMessageResult(
+                **{
+                    **pmsg_result._asdict(),
+                    "category": tag_to_section.get(pmsg_result.type, "None"),
+                }
             )
-
-        if parsed.group("subject"):
-            subject = parsed.group("subject")
-        else:
-            return _logged_parse_error(commit, f"Commit has no subject {message!r}")
-
-        if parsed.group("text"):
-            blocks = parsed.group("text").split("\n\n")
-            blocks = [x for x in blocks if x]
-            blocks.insert(0, subject)
-        else:
-            blocks = [subject]
-
-        for tag in self.options.allowed_tags:
-            if tag == parsed.group("tag"):
-                section = tag_to_section.get(tag, "None")
-                level_bump = self.options.tag_to_level.get(
-                    tag, self.options.default_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
-            logger.debug(
-                "commit %s introduces a level bump of %s due to the default bump level",
-                commit.hexsha[:8],
-                level_bump,
-            )
-
-        # Look for descriptions of breaking changes
-        migration_instructions = [
-            block for block in blocks if block.startswith("BREAKING CHANGE")
-        ]
-        if migration_instructions:
-            level_bump = LevelBump.MAJOR
-            logger.debug(
-                "commit %s upgraded to a %s level bump due to included migration instructions",
-                commit.hexsha[:8],
-                level_bump,
-            )
-
-        return ParsedCommit(
-            bump=level_bump,
-            type=section,
-            scope=parsed.group("scope"),
-            descriptions=blocks,
-            breaking_descriptions=migration_instructions,
-            commit=commit,
         )

semantic_release/commit_parser/token.py

@@ -10,6 +10,16 @@ if TYPE_CHECKING:
     from semantic_release.enums import LevelBump
 
 
+class ParsedMessageResult(NamedTuple):
+    bump: LevelBump
+    type: str
+    category: str
+    scope: str
+    descriptions: tuple[str, ...]
+    breaking_descriptions: tuple[str, ...] = ()
+    linked_merge_request: str = ""
+
+
 class ParsedCommit(NamedTuple):
     bump: LevelBump
     type: str
@@ -17,6 +27,7 @@ class ParsedCommit(NamedTuple):
     descriptions: list[str]
     breaking_descriptions: list[str]
     commit: Commit
+    linked_merge_request: str = ""
 
     @property
     def message(self) -> str:
@@ -32,6 +43,25 @@ class ParsedCommit(NamedTuple):
     def short_hash(self) -> str:
         return self.commit.hexsha[:7]
 
+    @property
+    def linked_pull_request(self) -> str:
+        return self.linked_merge_request
+
+    @staticmethod
+    def from_parsed_message_result(
+        commit: Commit, parsed_message_result: ParsedMessageResult
+    ) -> ParsedCommit:
+        return ParsedCommit(
+            bump=parsed_message_result.bump,
+            # TODO: breaking v10, swap back to type rather than category
+            type=parsed_message_result.category,
+            scope=parsed_message_result.scope,
+            descriptions=list(parsed_message_result.descriptions),
+            breaking_descriptions=list(parsed_message_result.breaking_descriptions),
+            commit=commit,
+            linked_merge_request=parsed_message_result.linked_merge_request,
+        )
+
 
 class ParseError(NamedTuple):
     commit: Commit

semantic_release/commit_parser/util.py

@@ -1,8 +1,33 @@
 from __future__ import annotations
 
-import re
+from functools import reduce
+from re import compile as regexp
+from typing import TYPE_CHECKING
 
-breaking_re = re.compile(r"BREAKING[ -]CHANGE:\s?(.*)")
+if TYPE_CHECKING:
+    from re import Pattern
+    from typing import TypedDict
+
+    class RegexReplaceDef(TypedDict):
+        pattern: Pattern
+        repl: str
+
+
+breaking_re = regexp(r"BREAKING[ -]CHANGE:\s?(.*)")
+un_word_wrap: RegexReplaceDef = {
+    # Match a line ending where the next line is not indented, or a bullet
+    "pattern": regexp(r"((?<!-)\n(?![\s*-]))"),
+    "repl": r" ",  # Replace with a space
+}
+un_word_wrap_hyphen: RegexReplaceDef = {
+    "pattern": regexp(r"((?<=\w)-\n(?=\w))"),
+    "repl": r"-",  # Replace with single hyphen
+}
+trim_line_endings: RegexReplaceDef = {
+    # Match line endings with optional whitespace
+    "pattern": regexp(r"[\r\t\f\v ]*\r?\n"),
+    "repl": "\n",  # remove the optional whitespace & remove windows newlines
+}
 
 
 def parse_paragraphs(text: str) -> list[str]:
@@ -16,12 +41,18 @@ def parse_paragraphs(text: str) -> list[str]:
     :param text: The text string to be divided.
     :return: A list of condensed paragraphs, as strings.
     """
+    adjusted_text = reduce(
+        lambda txt, adj: adj["pattern"].sub(adj["repl"], txt),
+        [trim_line_endings, un_word_wrap_hyphen],
+        text,
+    )
+
     return list(
         filter(
             None,
             [
-                paragraph.replace("\n", " ").strip()
-                for paragraph in text.replace("\r", "").split("\n\n")
+                un_word_wrap["pattern"].sub(un_word_wrap["repl"], paragraph).strip()
+                for paragraph in adjusted_text.split("\n\n")
             ],
         )
     )

semantic_release/data/templates/angular/md/.components/changes.md.j2

@@ -1,16 +1,44 @@
-{#
-#}{%  for type_, commits in commit_objects
-%}{{
-        "\n### %s\n" | format(type_ | title)
+{%   from 'macros.md.j2' import format_commit_summary_line
+%}{#
+EXAMPLE:
 
-}}{%    for commit in commits
-%}{{
-          "\n* %s ([`%s`](%s))\n" | format(
-              commit.message.rstrip(),
-              commit.short_hash,
-              commit.hexsha | commit_hash_url,
-          )
+### Features
 
+- Add new feature ([#10](https://domain.com/namespace/repo/pull/10),
+  [`abcdef0`](https://domain.com/namespace/repo/commit/HASH))
+
+- Add new feature ([`abcdef0`](https://domain.com/namespace/repo/commit/HASH))
+
+### Fixes
+
+- Fix bug ([#11](https://domain.com/namespace/repo/pull/11),
+  [`abcdef1`](https://domain.com/namespace/repo/commit/HASH))
+
+#}{%  set max_line_width = 100
+%}{%  set hanging_indent = 2
+%}{#
+#}{%  for type_, commits in commit_objects if type_ != "unknown"
+%}{#    PREPROCESS COMMITS (order by description & format description line)
+#}{%    set commit_descriptions = []
+%}{%    for commit in commits
+%}{#      # Update the first line with reference links and if commit description
+          # has more than one line, add the rest of the lines
+          # NOTE: This is specifically to make sure to not hide contents
+          # of squash commits (until parse support is added)
+#}{%      set description = "- %s" | format(format_commit_summary_line(commit))
+%}{%      if commit.descriptions | length > 1
+%}{%        set description = "%s\n\n%s" | format(
+              description, commit.descriptions[1:] | join("\n\n")
+            )
+%}{%      endif
+%}{%      set description = description | autofit_text_width(max_line_width, hanging_indent)
+%}{{      commit_descriptions.append(description) | default("", true)
 }}{%    endfor
-%}{%  endfor
+%}{#
+   #    # PRINT SECTION (header & commits)
+#}{{    "\n"
+}}{{    "### %s\n" | format(type_ | title)
+}}{{    "\n"
+}}{{    "%s\n" | format(commit_descriptions | unique | join("\n\n"))
+}}{%  endfor
 %}

semantic_release/data/templates/angular/md/.components/macros.md.j2

@@ -0,0 +1,48 @@
+{#
+  MACRO: commit message links or PR/MR links of commit
+#}{%  macro commit_msg_links(commit)
+%}{%    if commit.error is undefined
+%}{%      set commit_hash_link = "[`%s`](%s)" | format(
+            commit.short_hash, commit.hexsha | commit_hash_url
+          )
+%}{#
+#}{%      set summary_line = commit.descriptions[0] | safe
+%}{%      set summary_line = [
+            summary_line.split(" ", maxsplit=1)[0] | capitalize,
+            summary_line.split(" ", maxsplit=1)[1]
+          ] | join(" ")
+%}{#
+#}{%      if commit.linked_merge_request != ""
+%}{#        # Add PR references with a link to the PR
+#}{%        set pr_num = commit.linked_merge_request
+%}{%        set pr_link = "[%s](%s)" | format(pr_num, pr_num | pull_request_url)
+%}{#
+   #        TODO: breaking change v10, remove summary line replacers as PSR will do it for us
+#}{%        set summary_line = summary_line | replace("(pull request", "(") | replace("(" ~ pr_num ~ ")", "") | trim
+%}{%        set summary_line = "%s (%s, %s)" | format(
+              summary_line,
+              pr_link,
+              commit_hash_link,
+            )
+%}{#
+          # DEFAULT: No PR identifier found, so just append commit hash as url to the commit summary_line
+#}{%      else
+%}{%        set summary_line = "%s (%s)" | format(summary_line, commit_hash_link)
+%}{%      endif
+%}{#
+          # Return the modified summary_line
+#}{{      summary_line
+}}{%    endif
+%}{%  endmacro
+%}
+
+{#
+  MACRO: format commit summary line
+#}{%  macro format_commit_summary_line(commit)
+%}{%    if commit.error is undefined
+%}{{      commit_msg_links(commit)
+}}{%    else
+%}{{      (commit.commit.message | string).split("\n", maxsplit=1)[0]
+}}{%    endif
+%}{%  endmacro
+%}

semantic_release/data/templates/angular/md/CHANGELOG.md.j2

@@ -8,6 +8,7 @@
 
 #}{%  set insertion_flag = ctx.changelog_insertion_flag
 %}{%  set unreleased_commits = ctx.history.unreleased | dictsort
+%}{%  set releases = ctx.history.released.values() | list
 %}{#
 #}{%  if ctx.changelog_mode == "init"
 %}{%    include ".components/changelog_init.md.j2"
@@ -15,8 +16,8 @@
 #}{%  elif ctx.changelog_mode == "update"
 %}{%    set prev_changelog_file = ctx.prev_changelog_file
 %}{%    set new_releases = []
-%}{%    if ctx.history.released.values() | length > 0
-%}{%      set new_releases = [ctx.history.released.values() | first]
+%}{%    if releases | length > 0
+%}{%      set new_releases = [releases | first]
 %}{%    endif
 %}{%    include ".components/changelog_update.md.j2"
 %}{#

semantic_release/data/templates/angular/rst/.components/changes.rst.j2

@@ -1,36 +1,76 @@
-{% from 'macros.rst.j2' import generate_heading_underline, format_link_reference
+{%   from 'macros.rst.j2' import extract_pr_link_reference, format_link_reference
+%}{% from 'macros.rst.j2' import format_commit_summary_line, generate_heading_underline
 %}{#
 
 Features
 --------
 
-* summary (`8a7b8ec`_)
+* Add new feature (`#10`_, `8a7b8ec`_)
+
+* Add another feature (`abcdef0`_)
 
 Fixes
 -----
 
-* summary (`8a7b8ec`_)
+* Fix bug (`#11`_, `8a7b8ec`_)
 
-.. _8a7B8ec: https://github.com/owner/repo/commit/8a7b8ec
+.. _10: https://domain.com/namespace/repo/pull/10
+.. _8a7B8ec: https://domain.com/owner/repo/commit/8a7b8ec
+.. _abcdef0: https://domain.com/owner/repo/commit/abcdef0
+.. _11: https://domain.com/namespace/repo/pull/11
 
-#}{% set post_paragraph_links = []
+#}{%  set max_line_width = 100
+%}{%  set hanging_indent = 2
+%}{#
+#}{%  set post_paragraph_links = []
+%}{#
+#}{%  for type_, commits in commit_objects if type_ != "unknown"
+%}{#    PREPARE SECTION HEADER
+#}{%    set section_header = "%s" | format(type_ | title)
+%}{#    PREPROCESS COMMITS
+#}{%    set commit_descriptions = []
+%}{#
+#}{%    for commit in commits
+%}{#      # Extract PR/MR reference if it exists and store it for later
+#}{%      set pr_link_reference = extract_pr_link_reference(commit) | default("", true)
+%}{%      if pr_link_reference != ""
+%}{{        post_paragraph_links.append(pr_link_reference) | default("", true)
+}}{%      endif
+%}{#
+   #      # Always generate a commit hash reference link and store it for later
+#}{%      set commit_hash_link_reference = format_link_reference(
+            commit.hexsha | commit_hash_url,
+            commit.short_hash
+          )
+%}{{      post_paragraph_links.append(commit_hash_link_reference) | default("", true)
+}}{#
+          # Generate the commit summary line and format it for RST
+          # Update the first line with reference links and if commit description
+          # has more than one line, add the rest of the lines
+          # NOTE: This is specifically to make sure to not hide contents
+          # of squash commits (until parse support is added)
+#}{%      set description = "* %s" | format(format_commit_summary_line(commit))
+%}{%      if commit.descriptions | length > 1
+%}{%        set description = "%s\n\n%s" | format(
+              description, commit.descriptions[1:] | join("\n\n") | trim
+            )
+%}{%      endif
+%}{%      set description = description | convert_md_to_rst
+%}{%      set description = description | autofit_text_width(max_line_width, hanging_indent)
+%}{{      commit_descriptions.append(description) | default("", true)
+}}{%    endfor
 %}{#
-#}{% for type_, commits in commit_objects
-%}{%    set section_header = "%s" | format(type_ | title)
-%}{{    "\n"
+   #    # PRINT SECTION (Header & Commits)
+#}{{    "\n"
 }}{{    section_header ~ "\n"
 }}{{    generate_heading_underline(section_header, '-') ~ "\n"
-}}{#
-#}{%    for commit in commits
-%}{%        set commit_link_reference = format_link_reference(commit.hexsha | commit_hash_url, commit.short_hash)
-%}{{        post_paragraph_links.append(commit_link_reference) | default("", true)
 }}{{
-            "\n* %s (`%s`_)\n" | format(
-                commit.message.rstrip() | convert_md_to_rst,
-                commit.short_hash,
-            )
+        "\n%s\n" | format(commit_descriptions | unique | join("\n\n"))
 
-}}{%    endfor
-%}{% endfor
+}}{%  endfor
+%}{#
+#}{%  if post_paragraph_links | length > 0
+%}{#    # Print out any PR/MR or Issue URL references that were found in the commit messages
+#}{{    "\n%s\n" | format(post_paragraph_links | unique | sort | join("\n"))
+}}{%  endif
 %}
-{{ post_paragraph_links | join("\n") ~ "\n" }}

semantic_release/data/templates/angular/rst/.components/macros.rst.j2

@@ -1,9 +1,78 @@
-{# MACRO: format a post-paragraph link reference in RST #}
-{%    macro format_link_reference(link, label)
+{#
+  MACRO: format a post-paragraph link reference in RST
+#}{%  macro format_link_reference(link, label)
 %}{{    ".. _%s: %s" | format(label, link)
 }}{%  endmacro
 %}
 
+
+{#
+  MACRO: format commit summary line
+#}{%  macro format_commit_summary_line(commit)
+%}{%    if commit.error is undefined
+%}{{      commit_msg_links(commit)
+}}{%    else
+%}{{      (commit.commit.message | string).split("\n", maxsplit=1)[0]
+}}{%    endif
+%}{%  endmacro
+%}
+
+
+{#
+  MACRO: Create & return an non-inline RST link from a commit message
+  - Returns empty string if no PR/MR identifier is found
+#}{%  macro extract_pr_link_reference(commit)
+%}{%    if commit.error is undefined
+%}{%      set summary_line = commit.descriptions[0]
+%}{#
+#}{%      if commit.linked_merge_request != ""
+%}{#        # Create a PR/MR reference url
+#}{{        format_link_reference(
+              commit.linked_merge_request | pull_request_url,
+              commit.linked_merge_request,
+            )
+}}{%      endif
+%}{%    endif
+%}{%  endmacro
+%}
+
+
+{#
+  MACRO: formats a commit message for a non-inline RST link for a commit hash and/or PR/MR
+#}{%  macro commit_msg_links(commit, hvcs_type)
+%}{%    if commit.error is undefined
+%}{%      set commit_hash_link = "`%s`_" | format(commit.short_hash)
+%}{#
+#}{%      set summary_line = commit.descriptions[0] | safe
+%}{%      set summary_line = [
+            summary_line.split(" ", maxsplit=1)[0] | capitalize,
+            summary_line.split(" ", maxsplit=1)[1]
+          ] | join(" ")
+%}{#
+#}{%      if commit.linked_merge_request != ""
+%}{#        # Add PR references with a link to the PR
+#}{%        set pr_link = "`%s`_" | format(commit.linked_merge_request)
+%}{#
+   #        TODO: breaking change v10, remove summary line replacers as PSR will do it for us
+#}{%        set summary_line = summary_line | replace("(pull request ", "(") | replace("(" ~ commit.linked_merge_request ~ ")", "") | trim
+%}{%        set summary_line = "%s (%s, %s)" | format(
+              summary_line,
+              pr_link,
+              commit_hash_link,
+            )
+%}{#
+          # DEFAULT: No PR identifier found, so just append a commit hash as url to the commit summary_line
+#}{%      else
+%}{%        set summary_line = "%s (%s)" | format(summary_line, commit_hash_link)
+%}{%      endif
+%}{#
+          # Return the modified summary_line
+#}{{      summary_line
+}}{%    endif
+%}{%  endmacro
+%}
+
+
 {# MACRO: generate a heading underline that matches the exact length of the header #}
 {%    macro generate_heading_underline(header, underline_char)
 %}{%    set header_underline = []