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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-semantic-release
-Version: 9.12.2
+Version: 9.14.0
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT
@@ -44,7 +44,7 @@ Requires-Dist: sphinxcontrib-apidoc==0.5.0; extra == "docs"
 Requires-Dist: sphinx-autobuild==2024.2.4; extra == "docs"
 Requires-Dist: furo~=2024.1; extra == "docs"
 Provides-Extra: mypy
-Requires-Dist: mypy==1.11.2; extra == "mypy"
+Requires-Dist: mypy==1.13.0; extra == "mypy"
 Requires-Dist: types-requests~=2.32.0; extra == "mypy"
 Provides-Extra: test
 Requires-Dist: coverage[toml]~=7.0; extra == "test"

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

@@ -1,4 +1,4 @@
-semantic_release/__init__.py,sha256=DhNOjxINWOV6dyjCQmaizz8XX9v6ReMVyZLlzmMRtiw,1229
+semantic_release/__init__.py,sha256=kHQQzNnUYSMycf0e29x0t_WKKyKzPNRw9RkN73SVOpw,1229
 semantic_release/__main__.py,sha256=kuotDU7aFKrCBeAJUPWrbIxgJWAmrXUMnztCqWMDMPY,1292
 semantic_release/const.py,sha256=Z1o2QNh60wSLeF-_1TemMBjU3ZXbV0XghnUFsbTVfOs,831
 semantic_release/enums.py,sha256=D5B_reQGGKQQT22HO5PUtvn2Bok3fkht6TfJtXkmAUg,1020
@@ -7,45 +7,48 @@ semantic_release/gitproject.py,sha256=izWc4NLdUzAwxGG_fJeqqHW9ivSrPcWBzSaOijQx4f
 semantic_release/globals.py,sha256=imI9WKGa6MS2pTRAZiWZ2qIJup2eWnBz3OZmIj2YIHM,158
 semantic_release/helpers.py,sha256=d1jOX0SNyqPc_3wr14xR25FfpqhMd4Ev7MNBOWlScc0,5581
 semantic_release/changelog/__init__.py,sha256=Bg6Xe5Vt32rWoMscW-hd4sUwiZqzWmsg4CD1EhMesMY,262
-semantic_release/changelog/context.py,sha256=y37y3M7UmVKwhu9UatNtlo5zNfTOJI8gGOTIzjYXVa8,5023
+semantic_release/changelog/context.py,sha256=AQY9ZH1c5LjkyMcZyZG8Kjeyg0qvG_ueOWifgshtLWY,5354
 semantic_release/changelog/release_history.py,sha256=8RU6A4FMgWwwjndOO4WKjbSzPWgVsYbdcZol1xUPnfo,7815
 semantic_release/changelog/template.py,sha256=J1YJDI_SnXtBbTxoahN0NaVVHN7grOFghLwE9wDjxik,5685
 semantic_release/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-semantic_release/cli/changelog_writer.py,sha256=qucHQylViw61C8Rn3Lafbeyo80cjs2hxaCztd_EgIJ4,8859
+semantic_release/cli/changelog_writer.py,sha256=4XWAiH2qv3WBLxPm0D0S31-0XDm2QwSwyopiUmjUdJk,9029
 semantic_release/cli/cli_context.py,sha256=23eyV6KWIpUckUSWILEd7t9dixp-QCY5-kGZnyucEYY,4114
-semantic_release/cli/config.py,sha256=0btSbu5KKFZ3HFqR_-WDyToWXljfv1EOuBjBqwwFJcc,30654
+semantic_release/cli/config.py,sha256=XpFT5asSe65ye3Q63h9HaDJ4lTzWKyUBXyn_tZSdamk,30884
 semantic_release/cli/const.py,sha256=h7XE2D0D__TAZSrUUtVszwvzpkHTMOiQCf97XQNbEvA,163
 semantic_release/cli/github_actions_output.py,sha256=VYIOb5x5h8eEJdSlXM_mkhT9xXtYi-RgxvnoM7iUn8s,2288
 semantic_release/cli/masking_filter.py,sha256=DxqjiJyABlzwwwZ1r8JGQpb6QrF00StJFm0-2-s5Fv0,3071
 semantic_release/cli/util.py,sha256=FyXaBkeL7nXKjy3X9rQLEwvn7p46xPekp2V8Z-5MVrk,3755
 semantic_release/cli/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-semantic_release/cli/commands/changelog.py,sha256=kVHcGdfud74-M6hjWf1PS6l95gD4yUlu3CZGBkCt7aY,3765
+semantic_release/cli/commands/changelog.py,sha256=6SLdz8zHuLDXnB8JWz8NSko9c5YNLMmRoBw_9DrkRok,3834
 semantic_release/cli/commands/generate_config.py,sha256=2xZOu3NpyhBp0pWr7d8ugKl_kjqQgpSsSMHq5wHTfrE,1699
 semantic_release/cli/commands/main.py,sha256=wHG51tbaAHKra21nRe3-FAfQT81-e5PGhv0KnerS15c,4100
 semantic_release/cli/commands/publish.py,sha256=SZQlIewvqyIC14dkIIVVFetE0tPsKbO1cUyxnZsicrw,2845
-semantic_release/cli/commands/version.py,sha256=PKNoP_b8puzcScKkQEbeB3DviJv49cQ-vjq6v25nG9Q,23931
+semantic_release/cli/commands/version.py,sha256=z4UNNmQ0Fo2e-SKPzmF1CF517X5mk8oaiGttYJAiVzA,24000
 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/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/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=1wGyJGiML0FeSsHeywj4gv5qhAZHvs0wvea7eCIGiwM,558
+semantic_release/data/templates/angular/md/CHANGELOG.md.j2,sha256=FZmrQ-qOIoSoJmAa_NFaRelfmqUpypU2xlDeScdGOf4,729
 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/changelog_init.md.j2,sha256=MyEQdWUemGXKWDhvpTmubZdozd3iaLECZAI1VRlE7mg,862
+semantic_release/data/templates/angular/md/.components/changelog_update.md.j2,sha256=uVF4wbbjTMvl6Kbsq9xy3YIrj-uhBnHylEfA7S76aHI,2606
+semantic_release/data/templates/angular/md/.components/changes.md.j2,sha256=PAt_vMMoP5uMbDQZKemx26m13TNGGAOmBVD1sUU-KNo,1701
+semantic_release/data/templates/angular/md/.components/first_release.md.j2,sha256=jMUZiLwhMqAOjdYOCphJxJr8C411cKRzhsabyebj_AY,162
+semantic_release/data/templates/angular/md/.components/macros.md.j2,sha256=rvMLeThRRmCVyF_utN0j6wrWL5PVb4TYraunOWWcdu4,2275
 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/CHANGELOG.rst.j2,sha256=VmkXEMHiPBdZ1Z47QMxnJBZA0NbFSbKenUbThQVFAGY,731
 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/changelog_init.rst.j2,sha256=XD0l3eTyz1yydLKsmSqBk-u8RnO-RdQ2Q8uWezHMAWw,866
+semantic_release/data/templates/angular/rst/.components/changelog_update.rst.j2,sha256=x23-qk9owJrOQaHx8SgSnIZECITjPf1R2awfv9EOHN0,2604
+semantic_release/data/templates/angular/rst/.components/changes.rst.j2,sha256=REgnXdUDQKH2_BakQ-zbQtS4-MJMYKtA1jBXYFhfSjk,2915
+semantic_release/data/templates/angular/rst/.components/first_release.rst.j2,sha256=tChYsdSFMaB0DU9KROYSxijdb7tqaN1psKmDMbrVrJw,443
+semantic_release/data/templates/angular/rst/.components/macros.rst.j2,sha256=C4JkbfM9mfal-fMJJp6dPUT45PsqwfsCFu4pfZe34QI,3176
 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 +65,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.14.0.dist-info/AUTHORS.rst,sha256=XOReVvpymEFUPsS2QPH97jlfJBVrxwS2eu8-jVAe4gk,230
+python_semantic_release-9.14.0.dist-info/LICENSE,sha256=NE85nszX252sdQdu0xgS9qwfYES0k8qS6gW3uO4jRGE,1083
+python_semantic_release-9.14.0.dist-info/METADATA,sha256=tY6DDyFypAxFHo8kVuuCecr3h_siBZ7RO88JOQAIZQ4,3571
+python_semantic_release-9.14.0.dist-info/WHEEL,sha256=bFJAMchF8aTQGUgMZzHJyDDMPTO3ToJ7x23SLJa1SVo,92
+python_semantic_release-9.14.0.dist-info/entry_points.txt,sha256=r2Jql3GTQyugQnvf34l2eXk1O_Qx6llR_xixG1ZWgD0,105
+python_semantic_release-9.14.0.dist-info/top_level.txt,sha256=qYA24nyg3eP-ti5UW7Vuj2aXVmM0wqVHx4mREdRZNAA,17
+python_semantic_release-9.14.0.dist-info/RECORD,,

{python_semantic_release-9.12.2.dist-info → python_semantic_release-9.14.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.14.0"
 
 __all__ = [
     "CommitParser",

semantic_release/changelog/context.py

@@ -23,6 +23,7 @@ class ReleaseNotesContext:
     hvcs_type: str
     version: Version
     release: Release
+    mask_initial_release: bool
     filters: tuple[Callable[..., Any], ...] = ()
 
     def bind_to_environment(self, env: Environment) -> Environment:
@@ -53,6 +54,7 @@ class ChangelogContext:
     changelog_mode: Literal["update", "init"]
     prev_changelog_file: str
     changelog_insertion_flag: str
+    mask_initial_release: bool
     filters: tuple[Callable[..., Any], ...] = ()
 
     def bind_to_environment(self, env: Environment) -> Environment:
@@ -69,6 +71,7 @@ def make_changelog_context(
     mode: ChangelogMode,
     prev_changelog_file: Path,
     insertion_flag: str,
+    mask_initial_release: bool,
 ) -> ChangelogContext:
     return ChangelogContext(
         repo_name=hvcs_client.repo_name,
@@ -76,6 +79,7 @@ def make_changelog_context(
         history=release_history,
         changelog_mode=mode.value,
         changelog_insertion_flag=insertion_flag,
+        mask_initial_release=mask_initial_release,
         prev_changelog_file=str(prev_changelog_file),
         hvcs_type=hvcs_client.__class__.__name__.lower(),
         filters=(
@@ -111,6 +115,11 @@ def convert_md_to_rst(md_content: str) -> str:
         "bullets": (regexp(r"^(\s*)-(\s)"), r"\1*\2"),
         # Replace markdown inline raw content with rst inline raw content
         "raw-inline": (regexp(r"(?<=\s)(`[^`]+`)(?![`_])"), r"`\1`"),
+        # Replace markdown inline link with rst inline link
+        "link-inline": (
+            regexp(r"(?<=\s)\[([^\]]+)\]\(([^)]+)\)(?=\s|$)"),
+            r"`\1 <\2>`_",
+        ),
     }
 
     for pattern, replacement in replacements.values():

semantic_release/cli/changelog_writer.py

@@ -178,6 +178,7 @@ def write_changelog_files(
         mode=runtime_ctx.changelog_mode,
         insertion_flag=runtime_ctx.changelog_insertion_flag,
         prev_changelog_file=runtime_ctx.changelog_file,
+        mask_initial_release=runtime_ctx.changelog_mask_initial_release,
     )
 
     user_templates = []
@@ -226,6 +227,7 @@ def generate_release_notes(
     template_dir: Path,
     history: ReleaseHistory,
     style: str,
+    mask_initial_release: bool,
 ) -> str:
     users_tpl_file = template_dir / DEFAULT_RELEASE_NOTES_TPL_FILE
 
@@ -251,6 +253,7 @@ def generate_release_notes(
         hvcs_type=hvcs_client.__class__.__name__.lower(),
         version=release["version"],
         release=release,
+        mask_initial_release=mask_initial_release,
         filters=(*hvcs_client.get_changelog_context_filters(), autofit_text_width),
     ).bind_to_environment(
         # Use a new, non-configurable environment for release notes -
@@ -259,11 +262,9 @@ def generate_release_notes(
     )
 
     # TODO: Remove in v10
-    release_notes_env.globals["context"] = {
-        "history": history,
-    }
-    release_notes_env.globals["ctx"] = {
+    release_notes_env.globals["context"] = release_notes_env.globals["ctx"] = {
         "history": history,
+        "mask_initial_release": mask_initial_release,
     }
 
     return render_release_notes(

semantic_release/cli/commands/changelog.py

@@ -119,6 +119,7 @@ def changelog(cli_ctx: CliContextObj, release_tag: str | None) -> None:
         runtime.template_dir,
         release_history,
         style=runtime.changelog_style,
+        mask_initial_release=runtime.changelog_mask_initial_release,
     )
 
     try:

semantic_release/cli/commands/version.py

@@ -696,6 +696,7 @@ def version(  # noqa: C901
         runtime.template_dir,
         history=release_history,
         style=runtime.changelog_style,
+        mask_initial_release=runtime.changelog_mask_initial_release,
     )
 
     exception: Exception | None = None

semantic_release/cli/config.py

@@ -123,6 +123,8 @@ class ChangelogEnvironmentConfig(BaseModel):
 class DefaultChangelogTemplatesConfig(BaseModel):
     changelog_file: str = "CHANGELOG.md"
     output_format: ChangelogOutputFormat = ChangelogOutputFormat.NONE
+    # TODO: Breaking Change v10, it will become True
+    mask_initial_release: bool = False
 
     @model_validator(mode="after")
     def interpret_output_format(self) -> Self:
@@ -511,6 +513,7 @@ class RuntimeContext:
     version_declarations: Tuple[VersionDeclarationABC, ...]
     hvcs_client: hvcs.HvcsBase
     changelog_insertion_flag: str
+    changelog_mask_initial_release: bool
     changelog_mode: ChangelogMode
     changelog_file: Path
     changelog_style: str
@@ -795,6 +798,7 @@ class RuntimeContext:
             hvcs_client=hvcs_client,
             changelog_file=changelog_file,
             changelog_mode=raw.changelog.mode,
+            changelog_mask_initial_release=raw.changelog.default_templates.mask_initial_release,
             changelog_insertion_flag=raw.changelog.insertion_flag,
             assets=raw.assets,
             commit_author=commit_author,

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)