python-semantic-release 10.0.1__py3-none-any.whl → 10.1.0__py3-none-any.whl

{python_semantic_release-10.0.1.dist-info → python_semantic_release-10.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-semantic-release
-Version: 10.0.1
+Version: 10.1.0
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT
@@ -25,7 +25,7 @@ Requires-Dist: click-option-group~=0.5
 Requires-Dist: gitpython~=3.0
 Requires-Dist: requests~=2.25
 Requires-Dist: jinja2~=3.1
-Requires-Dist: python-gitlab<6.0.0,>=4.0.0
+Requires-Dist: python-gitlab<7.0.0,>=4.0.0
 Requires-Dist: tomlkit~=0.11
 Requires-Dist: dotty-dict~=1.3
 Requires-Dist: importlib-resources~=6.0
@@ -62,7 +62,7 @@ Requires-Dist: pre-commit~=3.5; extra == "dev"
 Requires-Dist: tox~=4.11; extra == "dev"
 Requires-Dist: ruff==0.6.1; extra == "dev"
 Provides-Extra: mypy
-Requires-Dist: mypy==1.15.0; extra == "mypy"
+Requires-Dist: mypy==1.16.0; extra == "mypy"
 Requires-Dist: types-Deprecated~=1.2; extra == "mypy"
 Requires-Dist: types-requests~=2.32.0; extra == "mypy"
 Requires-Dist: types-pyyaml~=6.0; extra == "mypy"

{python_semantic_release-10.0.1.dist-info → python_semantic_release-10.1.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-python_semantic_release-10.0.1.dist-info/licenses/LICENSE,sha256=NE85nszX252sdQdu0xgS9qwfYES0k8qS6gW3uO4jRGE,1083
+python_semantic_release-10.1.0.dist-info/licenses/LICENSE,sha256=NE85nszX252sdQdu0xgS9qwfYES0k8qS6gW3uO4jRGE,1083
 semantic_release/__init__.py,sha256=tRJWhrn_dUt0QycXD2DoJSfEP5uwmxngH7jvbG2i-hA,1317
 semantic_release/__main__.py,sha256=pksxr6g1vkKq98Q1lShsxG8tk55IMiSMHzAHKyFU5x0,1704
 semantic_release/const.py,sha256=wInJR7vcOgT1ysm5VuJQ6lD_ZGYnCwRVKz7Uz3htQc4,861
@@ -13,9 +13,9 @@ semantic_release/changelog/context.py,sha256=WeLQ2BvYEWunIF8XEl6ldQE4IRg0d7r8mYS
 semantic_release/changelog/release_history.py,sha256=kX6D9VReq85wnHz0D6JpmJJCfWA6axV6RToSM0O5laU,10602
 semantic_release/changelog/template.py,sha256=eqOjtVfBbksgTK4CAZOajfkaAcKueJ-FhFv99U3-J5E,5695
 semantic_release/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-semantic_release/cli/changelog_writer.py,sha256=oaaHnEspJMcdGtmgy0xyJV_7U2kBDhO3d_0ewr7N0rA,9284
+semantic_release/cli/changelog_writer.py,sha256=2jP5b0LK61Y2tb22GQSFFmwHwXd2WjbopgsMAmsQsfY,9284
 semantic_release/cli/cli_context.py,sha256=Nop71LdVCJOeSUHgTXunMyK3xAu_QKQC2cRp1QBVkX0,4134
-semantic_release/cli/config.py,sha256=uz8ifzPkM5inyiZmvLjbSv5v1oqCsg-2ocEwQiYXpwc,33458
+semantic_release/cli/config.py,sha256=4UCx4-jzKpggb7dZM3fnZoi8rPiUGWtEmLiCfWlro7I,33458
 semantic_release/cli/const.py,sha256=h7XE2D0D__TAZSrUUtVszwvzpkHTMOiQCf97XQNbEvA,163
 semantic_release/cli/github_actions_output.py,sha256=5m0IwIUu-Ntse_Uwrxhn5lYmaVN16JUyOADvmEgsYxg,2293
 semantic_release/cli/masking_filter.py,sha256=GsTyaoZbUVJLXVMqeXhCttXK84UnBQ8cNDSHxd52sOc,3218
@@ -25,16 +25,16 @@ semantic_release/cli/commands/changelog.py,sha256=wJfd4VVfrGnu2jnIpG25cdVcbXIX-E
 semantic_release/cli/commands/generate_config.py,sha256=2xZOu3NpyhBp0pWr7d8ugKl_kjqQgpSsSMHq5wHTfrE,1699
 semantic_release/cli/commands/main.py,sha256=u1zhkkvKCZ2TtUqjzvdFTe5UZsvfws_pjqqo6CY0bBo,4351
 semantic_release/cli/commands/publish.py,sha256=CE_LJTxFnc337MfpsfdJopi7QCwwE13GqGNQ-dNgWis,2871
-semantic_release/cli/commands/version.py,sha256=xBi_Y2M7gEpf7CSponCITTuVtxirhTdGsm7XlRGg05Q,25721
+semantic_release/cli/commands/version.py,sha256=E061zBntS7Wg5c2ftzl8ya5NjBqFRYBLR73KU5lKE5U,25684
 semantic_release/commit_parser/__init__.py,sha256=6euiDgj9bwOx1rP96vUjq090usviXkbo7OVOnRBGfcw,742
-semantic_release/commit_parser/_base.py,sha256=oDifeTmFDpS238cp_DDrGzfidaKeAD5olCB5IM4Q6z8,3058
-semantic_release/commit_parser/angular.py,sha256=dcJ7r9Aw6xlecPlzlwjonmlX3mlrgAPDZbRG6t2-6-w,19249
+semantic_release/commit_parser/_base.py,sha256=DLsHnbXG-39JkUbcnsBCSV2GmV35w1rasyoMhK8G0UE,3058
+semantic_release/commit_parser/angular.py,sha256=MY_fo9F4EZ-ac8wYzBR0uD94O5Li2D-8zEMR01wss4c,18534
 semantic_release/commit_parser/conventional.py,sha256=Iyy8txkshK8HikizFVa7pnJHBSWDhOhF45zR866QxQM,18672
 semantic_release/commit_parser/emoji.py,sha256=0VecUMMcj43UaKDZ2GaFFUG26zOJAvXsEobTHaXNkk0,17749
-semantic_release/commit_parser/scipy.py,sha256=aysk2r_jImZU2ovqNv5Us0abSO20Po7TQwUiKh8-7W0,19463
+semantic_release/commit_parser/scipy.py,sha256=gA9TfmrxGVvtv6kki6N_9abJx-_WlpBsSX2TBh0YgPw,19463
 semantic_release/commit_parser/tag.py,sha256=bVO2XghM0G_eW2rG9Xc2q5TPsjtxr-xcHK5RpE1u_HM,3537
-semantic_release/commit_parser/token.py,sha256=ECgi7eeSgk3Biq1Y_ChbFJZQLkrUpNvGhIaEOXrNC4M,7904
-semantic_release/commit_parser/util.py,sha256=_ACiopznjwINn4t1zPHl8bxZEc0zOAURTycNU-sXs3M,3959
+semantic_release/commit_parser/token.py,sha256=1_q8mJ4SRu7kNfa-Nxr8fEyuvCfjPgiPEitqSP1KR5g,7904
+semantic_release/commit_parser/util.py,sha256=hcLjc16o7l6y_5Hfl8IxmF4ijaJD62JdjdB2DJWAe-g,3959
 semantic_release/data/templates/conventional/md/.release_notes.md.j2,sha256=DlMVAJMGqE27TwJ-2kviYaFhd3uWqXiU6Ikl15Ukne8,2512
 semantic_release/data/templates/conventional/md/CHANGELOG.md.j2,sha256=FZmrQ-qOIoSoJmAa_NFaRelfmqUpypU2xlDeScdGOf4,729
 semantic_release/data/templates/conventional/md/.components/changelog_header.md.j2,sha256=qNxTuSr59CV_yyimVU_RYp5azCnK0l6nJ03Zf0u5Ugg,166
@@ -42,7 +42,7 @@ semantic_release/data/templates/conventional/md/.components/changelog_init.md.j2
 semantic_release/data/templates/conventional/md/.components/changelog_update.md.j2,sha256=uVF4wbbjTMvl6Kbsq9xy3YIrj-uhBnHylEfA7S76aHI,2606
 semantic_release/data/templates/conventional/md/.components/changes.md.j2,sha256=8uI1-wiUJkxM2ZoA8bk7tVkHWSK-mknmXYd3KHLOKAE,5554
 semantic_release/data/templates/conventional/md/.components/first_release.md.j2,sha256=-S2aJV3ka4YicLs8UF6BEV-CDnL8iXLcNRRIiENFrYE,421
-semantic_release/data/templates/conventional/md/.components/macros.md.j2,sha256=RzBVwKSCb-WmRIMFVQL9U157mAih-PzZ_iRcfyWkG20,8196
+semantic_release/data/templates/conventional/md/.components/macros.md.j2,sha256=RMvhwNScNmBgasGxsHI4WBodiJyZWa3_AMITvaqOqQY,6534
 semantic_release/data/templates/conventional/md/.components/unreleased_changes.md.j2,sha256=HRLj6cyRfPZXC0s-0Av6s0Gp3jKxWg9AIEtIXBVqJuY,177
 semantic_release/data/templates/conventional/md/.components/versioned_changes.md.j2,sha256=KbU7D_n_VqET7q2CLwBQ7931dvO7xQklADw-oY6ujlY,502
 semantic_release/data/templates/conventional/rst/CHANGELOG.rst.j2,sha256=VmkXEMHiPBdZ1Z47QMxnJBZA0NbFSbKenUbThQVFAGY,731
@@ -51,7 +51,7 @@ semantic_release/data/templates/conventional/rst/.components/changelog_init.rst.
 semantic_release/data/templates/conventional/rst/.components/changelog_update.rst.j2,sha256=x23-qk9owJrOQaHx8SgSnIZECITjPf1R2awfv9EOHN0,2604
 semantic_release/data/templates/conventional/rst/.components/changes.rst.j2,sha256=RJdKG28Cv-pov6I61O1W9KoYCIj1vkHC4_wHTs4zGvM,6922
 semantic_release/data/templates/conventional/rst/.components/first_release.rst.j2,sha256=huaO-B3BRs7h2LRks2a6-656W2qzURkzLiyuKvYxMTg,462
-semantic_release/data/templates/conventional/rst/.components/macros.rst.j2,sha256=WLNUD2H2V-5vrwT7TKelwQ2wclLcZxFs0E2Lk3Ld10U,9096
+semantic_release/data/templates/conventional/rst/.components/macros.rst.j2,sha256=6XquxXKWNH-RQR5-D7JGFrDghGQUNqu7KE3mr8dJxt8,7299
 semantic_release/data/templates/conventional/rst/.components/unreleased_changes.rst.j2,sha256=ARBhc1ZpKwehGKDvOMqukmN59mTJiHzHsS7rOfKYCt8,202
 semantic_release/data/templates/conventional/rst/.components/versioned_changes.rst.j2,sha256=5THfdfYRjHNEQZVUDt112124hFEZxu7J4qIdgn54O1Q,553
 semantic_release/hvcs/__init__.py,sha256=JwoaLOF-12L-OBo_9-tOXXhdiHKeVungA9865to2oZk,494
@@ -73,8 +73,8 @@ semantic_release/version/declarations/enum.py,sha256=3n5Py9DoFkmItIdsmtQrJgmAhep
 semantic_release/version/declarations/i_version_replacer.py,sha256=oP6BxJuxwI44roI6448tomShv1sMoy9ry8TlhhIQtfc,2416
 semantic_release/version/declarations/pattern.py,sha256=MpUmsHYGAVAuFSKSb29FLcWeUCEHG_TRyhMO-2DWAAs,8308
 semantic_release/version/declarations/toml.py,sha256=2K4DtX5Qq1iHT8cG8mISPTMmp50w6Av0KmLAKZPYqq8,4931
-python_semantic_release-10.0.1.dist-info/METADATA,sha256=z8-uQWknrvrheWKsXOStSmdSKWCjeac5R-zCATki9tY,3913
-python_semantic_release-10.0.1.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
-python_semantic_release-10.0.1.dist-info/entry_points.txt,sha256=kzkCyDJsMOwgpFwEWKE9wxN1tXaUP6g6GIO4xtc0QuE,162
-python_semantic_release-10.0.1.dist-info/top_level.txt,sha256=qYA24nyg3eP-ti5UW7Vuj2aXVmM0wqVHx4mREdRZNAA,17
-python_semantic_release-10.0.1.dist-info/RECORD,,
+python_semantic_release-10.1.0.dist-info/METADATA,sha256=d1umjuI-8VC5XbF-PYRHyKCjrKcu84URpK3xqwbl1j0,3913
+python_semantic_release-10.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+python_semantic_release-10.1.0.dist-info/entry_points.txt,sha256=kzkCyDJsMOwgpFwEWKE9wxN1tXaUP6g6GIO4xtc0QuE,162
+python_semantic_release-10.1.0.dist-info/top_level.txt,sha256=qYA24nyg3eP-ti5UW7Vuj2aXVmM0wqVHx4mREdRZNAA,17
+python_semantic_release-10.1.0.dist-info/RECORD,,

{python_semantic_release-10.0.1.dist-info → python_semantic_release-10.1.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.8.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

semantic_release/cli/changelog_writer.py

@@ -269,7 +269,7 @@ def generate_release_notes(
         environment(autoescape=False, template_dir=tpl_dir)
     )
 
-    # TODO: Remove in v10
+    # TODO: Remove in v11
     release_notes_env.globals["context"] = release_notes_env.globals["ctx"] = {
         "history": history,
         "mask_initial_release": mask_initial_release,

semantic_release/cli/commands/version.py

@@ -142,14 +142,10 @@ def apply_version_to_source_files(
     if not noop:
         logger.debug("Updating version %s in repository files...", version)
 
-    paths = list(
-        map(
-            lambda decl, new_version=version, noop=noop: (  # type: ignore[misc]
-                decl.update_file_w_version(new_version=new_version, noop=noop)
-            ),
-            version_declarations,
-        )
-    )
+    paths = [
+        decl.update_file_w_version(new_version=version, noop=noop)
+        for decl in version_declarations
+    ]
 
     repo_filepaths = [
         str(updated_file.relative_to(repo_dir))
@@ -650,10 +646,9 @@ def version(  # noqa: C901
         credential_masker=runtime.masker,
     )
 
-    # Preparing for committing changes
+    # Preparing for committing changes; we always stage files even if we're not committing them in order to support a two-stage commit
+    project.git_add(paths=all_paths_to_add, noop=opts.noop)
     if commit_changes:
-        project.git_add(paths=all_paths_to_add, noop=opts.noop)
-
         # NOTE: If we haven't modified any source code then we skip trying to make a commit
         # and any tag that we apply will be to the HEAD commit (made outside of
         # running PSR

semantic_release/cli/config.py

@@ -148,7 +148,7 @@ class DefaultChangelogTemplatesConfig(BaseModel):
 
 
 class ChangelogConfig(BaseModel):
-    # TODO: BREAKING CHANGE v10, move to DefaultChangelogTemplatesConfig
+    # TODO: BREAKING CHANGE v11, move to DefaultChangelogTemplatesConfig
     changelog_file: str = ""
     """Deprecated! Moved to 'default_templates.changelog_file'"""
 
@@ -191,7 +191,7 @@ class ChangelogConfig(BaseModel):
 
     @model_validator(mode="after")
     def move_changelog_file(self) -> Self:
-        # TODO: Remove this method in v10
+        # TODO: Remove this method in v11
         if not self.changelog_file:
             return self
 
@@ -441,7 +441,7 @@ class RawConfig(BaseModel):
             parser_opts_type = None
             # If the commit parser is a known one, pull the default options object from it
             if self.commit_parser in _known_commit_parsers:
-                # TODO: BREAKING CHANGE v10
+                # TODO: BREAKING CHANGE v11
                 # parser_opts_type = (
                 #     _known_commit_parsers[self.commit_parser]
                 #     .get_default_options()
@@ -454,7 +454,7 @@ class RawConfig(BaseModel):
                 try:
                     # if its a custom parser, try to import it and pull the default options object type
                     custom_class = dynamic_import(self.commit_parser)
-                    # TODO: BREAKING CHANGE v10
+                    # TODO: BREAKING CHANGE v11
                     # parser_opts_type = custom_class.get_default_options().__class__
                     if hasattr(custom_class, "parser_options"):
                         parser_opts_type = custom_class.parser_options
@@ -695,7 +695,7 @@ class RuntimeContext:
             ) from err
 
         commit_parser_opts_class = commit_parser_cls.parser_options
-        # TODO: Breaking change v10
+        # TODO: Breaking change v11
         # commit_parser_opts_class = commit_parser_cls.get_default_options().__class__
         try:
             commit_parser = commit_parser_cls(

semantic_release/commit_parser/_base.py

@@ -74,7 +74,7 @@ class CommitParser(ABC, Generic[_TT, _OPTS]):
             options if options is not None else self.get_default_options()
         )
 
-    # TODO: BREAKING CHANGE v10, add abstract method for all custom parsers
+    # TODO: BREAKING CHANGE v11, add abstract method for all custom parsers
     # @staticmethod
     # @abstractmethod
     def get_default_options(self) -> _OPTS:

semantic_release/commit_parser/angular.py

@@ -94,11 +94,9 @@ class AngularParserOptions(ParserOptions):
     default_bump_level: LevelBump = LevelBump.NO_RELEASE
     """The minimum bump level to apply to valid commit message."""
 
-    # TODO: breaking change v10, change default to True
     parse_squash_commits: bool = False
     """Toggle flag for whether or not to parse squash commits"""
 
-    # TODO: breaking change v10, change default to True
     ignore_merge_commits: bool = False
     """Toggle flag for whether or not to ignore merge commits"""
 
@@ -236,15 +234,11 @@ class AngularCommitParser(CommitParser[ParseResult, AngularParserOptions]):
     ) -> dict[str, list[str]]:
         if (match := breaking_re.match(text)) and (brk_desc := match.group(1)):
             accumulator["breaking_descriptions"].append(brk_desc)
-            # TODO: breaking change v10, removes breaking change footers from descriptions
-            # return accumulator
 
         elif (match := self.notice_selector.match(text)) and (
             notice := match.group("notice")
         ):
             accumulator["notices"].append(notice)
-            # TODO: breaking change v10, removes notice footers from descriptions
-            # return accumulator
 
         elif match := self.issue_selector.search(text):
             # if match := self.issue_selector.search(text):
@@ -265,8 +259,6 @@ class AngularCommitParser(CommitParser[ParseResult, AngularParserOptions]):
                 accumulator["linked_issues"] = sort_numerically(
                     set(accumulator["linked_issues"]).union(new_issue_refs)
                 )
-                # TODO: breaking change v10, removes resolution footers from descriptions
-                # return accumulator
 
         # Prevent appending duplicate descriptions
         if text not in accumulator["descriptions"]:
@@ -287,9 +279,6 @@ class AngularCommitParser(CommitParser[ParseResult, AngularParserOptions]):
         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,

semantic_release/commit_parser/scipy.py

@@ -145,7 +145,7 @@ class ScipyParserOptions(ParserOptions):
     one of these prefixes, it will not be considered a valid commit message.
     """
 
-    # TODO: breaking v10, make consistent with AngularParserOptions
+    # TODO: breaking v11, make consistent with AngularParserOptions
     default_level_bump: LevelBump = LevelBump.NO_RELEASE
     """The minimum bump level to apply to valid commit message."""
 
@@ -161,7 +161,7 @@ class ScipyParserOptions(ParserOptions):
         return self._tag_to_level
 
     def __post_init__(self) -> None:
-        # TODO: breaking v10, remove as the name is now consistent
+        # TODO: breaking v11, remove as the name is now consistent
         self.default_bump_level = self.default_level_bump
         self._tag_to_level: dict[str, LevelBump] = {
             str(tag): level

semantic_release/commit_parser/token.py

@@ -150,7 +150,7 @@ class ParsedCommit(NamedTuple):
         """A convience method to create a ParsedCommit object from a ParsedMessageResult object and a Commit object."""
         return ParsedCommit(
             bump=parsed_message_result.bump,
-            # TODO: breaking v10, swap back to type rather than category
+            # TODO: breaking v11, swap back to type rather than category
             type=parsed_message_result.category,
             scope=parsed_message_result.scope,
             descriptions=list(parsed_message_result.descriptions),

semantic_release/commit_parser/util.py

@@ -6,7 +6,7 @@ from functools import reduce
 from re import MULTILINE, compile as regexp
 from typing import TYPE_CHECKING
 
-# TODO: remove in v10
+# TODO: remove in v11
 from semantic_release.helpers import (
     sort_numerically,  # noqa: F401 # TODO: maintained for compatibility
 )

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

@@ -6,41 +6,50 @@
 %}
 
 
+{#
+  MACRO: Capitalize the first letter of a string only
+#}{%  macro capitalize_first_letter_only(sentence)
+%}{{    (sentence[0] | upper) ~ sentence[1:]
+}}{%  endmacro
+%}
+
+
 {#
   MACRO: commit message links or PR/MR links of commit
 #}{%  macro commit_msg_links(commit)
 %}{%    if commit.error is undefined
-%}{%      set commit_hash_link = format_link(
-            commit.hexsha | commit_hash_url,
-            "`%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(" ")
+   #      # Initialize variables
+#}{%      set link_references = []
+%}{%      set summary_line = capitalize_first_letter_only(
+            commit.descriptions[0] | safe
+          )
 %}{#
 #}{%      if commit.linked_merge_request != ""
 %}{#        # Add PR references with a link to the PR
-#}{%        set pr_num = commit.linked_merge_request
-%}{%        set pr_link = format_link(pr_num | pull_request_url, pr_num)
-%}{#
-   #        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,
+#}{%        set _ = link_references.append(
+              format_link(
+                commit.linked_merge_request | pull_request_url,
+                commit.linked_merge_request
+              )
             )
+%}{%      endif
+%}{#
+   #      # DEFAULT: Always include the commit hash as a link
+#}{%      set _ = link_references.append(
+            format_link(
+              commit.hexsha | commit_hash_url,
+              "`%s`" | format(commit.short_hash)
+            )
+          )
 %}{#
-          # 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)
+#}{%      set formatted_links = ""
+%}{%      if link_references | length > 0
+%}{%        set formatted_links = " (%s)" | format(link_references | join(", "))
 %}{%      endif
 %}{#
           # Return the modified summary_line
-#}{{      summary_line
+#}{{      summary_line ~ formatted_links
 }}{%    endif
 %}{%  endmacro
 %}
@@ -71,24 +80,21 @@
 
 
 {#
-  MACRO: format the breaking changes description by:
-  - Capitalizing the description
+  MACRO: format a commit descriptions list by:
+  - Capitalizing the first line of the description
   - Adding an optional scope prefix
-#}{%  macro format_breaking_changes_description(commit)
-%}{%    set ns = namespace(full_description="")
+  - Joining the rest of the descriptions with a double newline
+#}{%  macro format_attr_paragraphs(commit, attribute)
+%}{#    NOTE: requires namespace because of the way Jinja2 handles variable scoping with loops
+#}{%    set ns = namespace(full_description="")
 %}{#
 #}{%    if commit.error is undefined
-%}{%      for paragraph in commit.breaking_descriptions
+%}{%      for paragraph in commit | attr(attribute)
 %}{%        if paragraph | trim | length > 0
 %}{#
-#}{%          set paragraph_text = [
-                paragraph.split(" ", maxsplit=1)[0] | capitalize,
-                paragraph.split(" ", maxsplit=1)[1]
-              ] | join(" ") | trim | safe
-%}{#
 #}{%          set ns.full_description = [
                 ns.full_description,
-                paragraph_text
+                capitalize_first_letter_only(paragraph) | trim | safe,
               ] | join("\n\n")
 %}{#
 #}{%        endif
@@ -108,65 +114,48 @@
 %}
 
 
+{#
+  MACRO: format the breaking changes description by:
+  - Capitalizing the description
+  - Adding an optional scope prefix
+#}{%  macro format_breaking_changes_description(commit)
+%}{{    format_attr_paragraphs(commit, 'breaking_descriptions')
+}}{%  endmacro
+%}
+
+
 {#
   MACRO: format the release notice by:
   - Capitalizing the description
   - Adding an optional scope prefix
 #}{%  macro format_release_notice(commit)
-%}{%    set ns = namespace(full_description="")
-%}{#
-#}{%    if commit.error is undefined
-%}{%      for paragraph in commit.release_notices
-%}{%        if paragraph | trim | length > 0
-%}{#
-#}{%          set paragraph_text = [
-                paragraph.split(" ", maxsplit=1)[0] | capitalize,
-                paragraph.split(" ", maxsplit=1)[1]
-              ] | join(" ") | trim | safe
-%}{#
-#}{%          set ns.full_description = [
-                ns.full_description,
-                paragraph_text
-              ] | join("\n\n")
-%}{#
-#}{%        endif
-%}{%      endfor
-%}{#
-#}{%      set ns.full_description = ns.full_description | trim
-%}{#
-#}{%      if commit.scope
-%}{%        set ns.full_description = "**%s**: %s" | format(
-              commit.scope, ns.full_description
-            )
-%}{%      endif
-%}{%    endif
-%}{#
-#}{{    ns.full_description
+%}{{    format_attr_paragraphs(commit, "release_notices")
 }}{%  endmacro
 %}
 
 
 {#
-  MACRO: apply smart ordering of commits objects based on alphabetized summaries and then scopes
-  - Commits are sorted based on the commit type and the commit message
-  - Commits are grouped by the commit type
-  - parameter: ns (namespace) object with a commits list
-  - returns None but modifies the ns.commits list in place
-#}{%  macro apply_alphabetical_ordering_by_descriptions(ns)
+   MACRO: order commits alphabetically by scope and attribute
+   - Commits are sorted based on scope and then the attribute alphabetically
+   - Commits without scope are placed first and sorted alphabetically by the attribute
+   - parameter: ns (namespace) object with a commits list
+   - parameter: attr (string) attribute to sort by
+   - returns None but modifies the ns.commits list in place
+#}{%  macro order_commits_alphabetically_by_scope_and_attr(ns, attr)
 %}{%    set ordered_commits = []
 %}{#
    #    # Eliminate any ParseError commits from input set
 #}{%    set filtered_commits = ns.commits | rejectattr("error", "defined") | list
 %}{#
-   #    # grab all commits with no scope and sort alphabetically by the first line of the commit message
-#}{%    for commit in filtered_commits | rejectattr("scope") | sort(attribute='descriptions.0')
-%}{{      ordered_commits.append(commit) | default("", true)
-}}{%     endfor
+   #    # grab all commits with no scope and sort alphabetically by attr
+#}{%    for commit in filtered_commits | rejectattr("scope") | sort(attribute=attr)
+%}{%      set _ = ordered_commits.append(commit)
+%}{%     endfor
 %}{#
-   #    # grab all commits with a scope and sort alphabetically by the scope and then the first line of the commit message
-#}{%    for commit in filtered_commits | selectattr("scope") | sort(attribute='scope,descriptions.0')
-%}{{      ordered_commits.append(commit) | default("", true)
-}}{%    endfor
+   #    # grab all commits with a scope and sort alphabetically by the scope and then attr
+#}{%    for commit in filtered_commits | selectattr("scope") | sort(attribute=(['scope', attr] | join(",")))
+%}{%      set _ = ordered_commits.append(commit)
+%}{%    endfor
 %}{#
    #    # Return the ordered commits
 #}{%    set ns.commits = ordered_commits
@@ -174,6 +163,18 @@
 %}
 
 
+{#
+  MACRO: apply smart ordering of commits objects based on alphabetized summaries and then scopes
+  - Commits are sorted based on the commit type and the commit message
+  - Commits are grouped by the commit type
+  - parameter: ns (namespace) object with a commits list
+  - returns None but modifies the ns.commits list in place
+#}{%  macro apply_alphabetical_ordering_by_descriptions(ns)
+%}{%    set _ = order_commits_alphabetically_by_scope_and_attr(ns, 'descriptions.0')
+%}{%  endmacro
+%}
+
+
 {#
   MACRO: apply smart ordering of commits objects based on alphabetized breaking changes and then scopes
   - Commits are sorted based on the commit type and the commit message
@@ -181,23 +182,7 @@
   - parameter: ns (namespace) object with a commits list
   - returns None but modifies the ns.commits list in place
 #}{%  macro apply_alphabetical_ordering_by_brk_descriptions(ns)
-%}{%    set ordered_commits = []
-%}{#
-   #    # Eliminate any ParseError commits from input set
-#}{%    set filtered_commits = ns.commits | rejectattr("error", "defined") | list
-%}{#
-   #    # grab all commits with no scope and sort alphabetically by the first line of the commit message
-#}{%    for commit in filtered_commits | rejectattr("scope") | sort(attribute='breaking_descriptions.0')
-%}{{      ordered_commits.append(commit) | default("", true)
-}}{%     endfor
-%}{#
-   #    # grab all commits with a scope and sort alphabetically by the scope and then the first line of the commit message
-#}{%    for commit in filtered_commits | selectattr("scope") | sort(attribute='scope,breaking_descriptions.0')
-%}{{      ordered_commits.append(commit) | default("", true)
-}}{%    endfor
-%}{#
-   #    # Return the ordered commits
-#}{%    set ns.commits = ordered_commits
+%}{%    set _ = order_commits_alphabetically_by_scope_and_attr(ns, 'breaking_descriptions.0')
 %}{%  endmacro
 %}
 
@@ -209,22 +194,6 @@
   - parameter: ns (namespace) object with a commits list
   - returns None but modifies the ns.commits list in place
 #}{%  macro apply_alphabetical_ordering_by_release_notices(ns)
-%}{%    set ordered_commits = []
-%}{#
-   #    # Eliminate any ParseError commits from input set
-#}{%    set filtered_commits = ns.commits | rejectattr("error", "defined") | list
-%}{#
-   #    # grab all commits with no scope and sort alphabetically by the first line of the commit message
-#}{%    for commit in filtered_commits | rejectattr("scope") | sort(attribute='release_notices.0')
-%}{{      ordered_commits.append(commit) | default("", true)
-}}{%     endfor
-%}{#
-   #    # grab all commits with a scope and sort alphabetically by the scope and then the first line of the commit message
-#}{%    for commit in filtered_commits | selectattr("scope") | sort(attribute='scope,release_notices.0')
-%}{{      ordered_commits.append(commit) | default("", true)
-}}{%    endfor
-%}{#
-   #    # Return the ordered commits
-#}{%    set ns.commits = ordered_commits
+%}{%    set _ = order_commits_alphabetically_by_scope_and_attr(ns, 'release_notices.0')
 %}{%  endmacro
 %}

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

@@ -1,3 +1,11 @@
+{#
+  MACRO: Capitalize the first letter of a string only
+#}{%  macro capitalize_first_letter_only(sentence)
+%}{{    (sentence[0] | upper) ~ sentence[1:]
+}}{%  endmacro
+%}
+
+
 {#
   MACRO: format a post-paragraph link reference in RST
 #}{%  macro format_link_reference(link, label)
@@ -6,6 +14,49 @@
 %}
 
 
+{# MACRO: generate a heading underline that matches the exact length of the header #}
+{%    macro generate_heading_underline(header, underline_char)
+%}{%    set header_underline = []
+%}{%    for _ in header
+%}{%      set __ = header_underline.append(underline_char)
+%}{%    endfor
+%}{#    # Print out the header underline
+#}{{    header_underline | join
+}}{%  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)
+%}{%    if commit.error is undefined
+%}{#
+   #      # Initialize variables
+#}{%      set link_references = []
+%}{%      set summary_line = capitalize_first_letter_only(
+            commit.descriptions[0] | safe
+          )
+%}{#
+#}{%      if commit.linked_merge_request != ""
+%}{#        # Add PR/MR references with a link to the PR/MR
+#}{%        set _ = link_references.append("`%s`_" | format(commit.linked_merge_request))
+%}{%      endif
+%}{#
+          # DEFAULT: Always include the commit hash as a link
+#}{%      set _ = link_references.append("`%s`_" | format(commit.short_hash))
+%}{#
+#}{%      set formatted_links = ""
+%}{%      if link_references | length > 0
+%}{%        set formatted_links = " (%s)" | format(link_references | join(", "))
+%}{%      endif
+%}{#
+          # Return the modified summary_line
+#}{{      summary_line ~ formatted_links
+}}{%    endif
+%}{%  endmacro
+%}
+
+
 {#
   MACRO: format commit summary line
 #}{%  macro format_commit_summary_line(commit)
@@ -50,72 +101,21 @@
 
 
 {#
-  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 = []
-%}{%    for _ in header
-%}{{      header_underline.append(underline_char) | default("", true)
-}}{%    endfor
-%}{#    # Print out the header underline
-#}{{    header_underline | join
-}}{%  endmacro
-%}
-
-
-{#
-  MACRO: format the breaking changes description by:
-  - Capitalizing the description
+  MACRO: format a commit descriptions list by:
+  - Capitalizing the first line of the description
   - Adding an optional scope prefix
-#}{%  macro format_breaking_changes_description(commit)
-%}{%    set ns = namespace(full_description="")
+  - Joining the rest of the descriptions with a double newline
+#}{%  macro format_attr_paragraphs(commit, attribute)
+%}{#    NOTE: requires namespace because of the way Jinja2 handles variable scoping with loops
+#}{%    set ns = namespace(full_description="")
 %}{#
 #}{%    if commit.error is undefined
-%}{%      for paragraph in commit.breaking_descriptions
+%}{%      for paragraph in commit | attr(attribute)
 %}{%        if paragraph | trim | length > 0
 %}{#
-#}{%          set paragraph_text = [
-                paragraph.split(" ", maxsplit=1)[0] | capitalize,
-                paragraph.split(" ", maxsplit=1)[1]
-              ] | join(" ") | trim | safe
-%}{#
 #}{%          set ns.full_description = [
                 ns.full_description,
-                paragraph_text
+                capitalize_first_letter_only(paragraph) | trim | safe,
               ] | join("\n\n")
 %}{#
 #}{%        endif
@@ -135,65 +135,48 @@
 %}
 
 
+{#
+  MACRO: format the breaking changes description by:
+  - Capitalizing the description
+  - Adding an optional scope prefix
+#}{%  macro format_breaking_changes_description(commit)
+%}{{    format_attr_paragraphs(commit, 'breaking_descriptions')
+}}{%  endmacro
+%}
+
+
 {#
   MACRO: format the release notice by:
   - Capitalizing the description
   - Adding an optional scope prefix
 #}{%  macro format_release_notice(commit)
-%}{%    set ns = namespace(full_description="")
-%}{#
-#}{%    if commit.error is undefined
-%}{%      for paragraph in commit.release_notices
-%}{%        if paragraph | trim | length > 0
-%}{#
-#}{%          set paragraph_text = [
-                paragraph.split(" ", maxsplit=1)[0] | capitalize,
-                paragraph.split(" ", maxsplit=1)[1]
-              ] | join(" ") | trim | safe
-%}{#
-#}{%          set ns.full_description = [
-                ns.full_description,
-                paragraph_text
-              ] | join("\n\n")
-%}{#
-#}{%        endif
-%}{%      endfor
-%}{#
-#}{%      set ns.full_description = ns.full_description | trim
-%}{#
-#}{%      if commit.scope
-%}{%        set ns.full_description = "**%s**: %s" | format(
-              commit.scope, ns.full_description
-            )
-%}{%      endif
-%}{%    endif
-%}{#
-#}{{    ns.full_description
+%}{{    format_attr_paragraphs(commit, "release_notices")
 }}{%  endmacro
 %}
 
 
 {#
-  MACRO: apply smart ordering of commits objects based on alphabetized summaries and then scopes
-  - Commits are sorted based on the commit type and the commit message
-  - Commits are grouped by the commit type
-  - parameter: ns (namespace) object with a commits list
-  - returns None but modifies the ns.commits list in place
-#}{%  macro apply_alphabetical_ordering_by_descriptions(ns)
+   MACRO: order commits alphabetically by scope and attribute
+   - Commits are sorted based on scope and then the attribute alphabetically
+   - Commits without scope are placed first and sorted alphabetically by the attribute
+   - parameter: ns (namespace) object with a commits list
+   - parameter: attr (string) attribute to sort by
+   - returns None but modifies the ns.commits list in place
+#}{%  macro order_commits_alphabetically_by_scope_and_attr(ns, attr)
 %}{%    set ordered_commits = []
 %}{#
    #    # Eliminate any ParseError commits from input set
 #}{%    set filtered_commits = ns.commits | rejectattr("error", "defined") | list
 %}{#
-   #    # grab all commits with no scope and sort alphabetically by the first line of the commit message
-#}{%    for commit in filtered_commits | rejectattr("scope") | sort(attribute='descriptions.0')
-%}{{      ordered_commits.append(commit) | default("", true)
-}}{%     endfor
+   #    # grab all commits with no scope and sort alphabetically by attr
+#}{%    for commit in filtered_commits | rejectattr("scope") | sort(attribute=attr)
+%}{%      set _ = ordered_commits.append(commit)
+%}{%     endfor
 %}{#
-   #    # grab all commits with a scope and sort alphabetically by the scope and then the first line of the commit message
-#}{%    for commit in filtered_commits | selectattr("scope") | sort(attribute='scope,descriptions.0')
-%}{{      ordered_commits.append(commit) | default("", true)
-}}{%    endfor
+   #    # grab all commits with a scope and sort alphabetically by the scope and then attr
+#}{%    for commit in filtered_commits | selectattr("scope") | sort(attribute=(['scope', attr] | join(",")))
+%}{%      set _ = ordered_commits.append(commit)
+%}{%    endfor
 %}{#
    #    # Return the ordered commits
 #}{%    set ns.commits = ordered_commits
@@ -201,6 +184,18 @@
 %}
 
 
+{#
+  MACRO: apply smart ordering of commits objects based on alphabetized summaries and then scopes
+  - Commits are sorted based on the commit type and the commit message
+  - Commits are grouped by the commit type
+  - parameter: ns (namespace) object with a commits list
+  - returns None but modifies the ns.commits list in place
+#}{%  macro apply_alphabetical_ordering_by_descriptions(ns)
+%}{%    set _ = order_commits_alphabetically_by_scope_and_attr(ns, 'descriptions.0')
+%}{%  endmacro
+%}
+
+
 {#
   MACRO: apply smart ordering of commits objects based on alphabetized breaking changes and then scopes
   - Commits are sorted based on the commit type and the commit message
@@ -208,23 +203,7 @@
   - parameter: ns (namespace) object with a commits list
   - returns None but modifies the ns.commits list in place
 #}{%  macro apply_alphabetical_ordering_by_brk_descriptions(ns)
-%}{%    set ordered_commits = []
-%}{#
-   #    # Eliminate any ParseError commits from input set
-#}{%    set filtered_commits = ns.commits | rejectattr("error", "defined") | list
-%}{#
-   #    # grab all commits with no scope and sort alphabetically by the first line of the commit message
-#}{%    for commit in filtered_commits | rejectattr("scope") | sort(attribute='breaking_descriptions.0')
-%}{{      ordered_commits.append(commit) | default("", true)
-}}{%     endfor
-%}{#
-   #    # grab all commits with a scope and sort alphabetically by the scope and then the first line of the commit message
-#}{%    for commit in filtered_commits | selectattr("scope") | sort(attribute='scope,breaking_descriptions.0')
-%}{{      ordered_commits.append(commit) | default("", true)
-}}{%    endfor
-%}{#
-   #    # Return the ordered commits
-#}{%    set ns.commits = ordered_commits
+%}{%    set _ = order_commits_alphabetically_by_scope_and_attr(ns, 'breaking_descriptions.0')
 %}{%  endmacro
 %}
 
@@ -236,22 +215,6 @@
   - parameter: ns (namespace) object with a commits list
   - returns None but modifies the ns.commits list in place
 #}{%  macro apply_alphabetical_ordering_by_release_notices(ns)
-%}{%    set ordered_commits = []
-%}{#
-   #    # Eliminate any ParseError commits from input set
-#}{%    set filtered_commits = ns.commits | rejectattr("error", "defined") | list
-%}{#
-   #    # grab all commits with no scope and sort alphabetically by the first line of the commit message
-#}{%    for commit in filtered_commits | rejectattr("scope") | sort(attribute='release_notices.0')
-%}{{      ordered_commits.append(commit) | default("", true)
-}}{%     endfor
-%}{#
-   #    # grab all commits with a scope and sort alphabetically by the scope and then the first line of the commit message
-#}{%    for commit in filtered_commits | selectattr("scope") | sort(attribute='scope,release_notices.0')
-%}{{      ordered_commits.append(commit) | default("", true)
-}}{%    endfor
-%}{#
-   #    # Return the ordered commits
-#}{%    set ns.commits = ordered_commits
+%}{%    set _ = order_commits_alphabetically_by_scope_and_attr(ns, 'release_notices.0')
 %}{%  endmacro
 %}