python-semantic-release 9.8.3__py3-none-any.whl → 9.8.4__py3-none-any.whl

{python_semantic_release-9.8.3.dist-info → python_semantic_release-9.8.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-semantic-release
-Version: 9.8.3
+Version: 9.8.4
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT
@@ -37,15 +37,15 @@ Requires-Dist: build ~=1.2 ; extra == 'build'
 Provides-Extra: dev
 Requires-Dist: pre-commit ~=3.5 ; extra == 'dev'
 Requires-Dist: tox ~=4.11 ; extra == 'dev'
-Requires-Dist: ruff ==0.4.9 ; extra == 'dev'
+Requires-Dist: ruff ==0.5.0 ; extra == 'dev'
 Provides-Extra: docs
 Requires-Dist: Sphinx ~=6.0 ; extra == 'docs'
 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.10.0 ; extra == 'mypy'
-Requires-Dist: types-requests ~=2.31.0 ; extra == 'mypy'
+Requires-Dist: mypy ==1.10.1 ; extra == 'mypy'
+Requires-Dist: types-requests ~=2.32.0 ; extra == 'mypy'
 Provides-Extra: test
 Requires-Dist: coverage[toml] ~=7.0 ; extra == 'test'
 Requires-Dist: pytest ~=7.0 ; extra == 'test'

{python_semantic_release-9.8.3.dist-info → python_semantic_release-9.8.4.dist-info}/RECORD

@@ -1,32 +1,33 @@
-semantic_release/__init__.py,sha256=uLmkFIh4Q9cOM3_CTkDX-83OfqCUiHwEpU0k8ZGmoWA,870
-semantic_release/__main__.py,sha256=vXOARLV7KHeVXgpOMU0Q-8wovpdsOrtTsycxulI5xIE,106
+semantic_release/__init__.py,sha256=2zPAOZ5IfYsvLnhab9ZWAjy_bunkNmm0OwE3CVcP6rI,1228
+semantic_release/__main__.py,sha256=blPn7CMpuSe4Z-GBIDv0QA0OEDTMGU-7edsLRkkhPR4,120
 semantic_release/const.py,sha256=Z1o2QNh60wSLeF-_1TemMBjU3ZXbV0XghnUFsbTVfOs,831
 semantic_release/enums.py,sha256=D5B_reQGGKQQT22HO5PUtvn2Bok3fkht6TfJtXkmAUg,1020
-semantic_release/errors.py,sha256=2hrKuCRWN5O_0z-C2Owf6gcTUe2MpP4Y27nHoUzJBng,1695
+semantic_release/errors.py,sha256=bPQDMW9MVhCwkE_TrpsmsRYZRuk5iOnqi-hKeujXQc0,2676
+semantic_release/gitproject.py,sha256=izWc4NLdUzAwxGG_fJeqqHW9ivSrPcWBzSaOijQx4f8,8564
 semantic_release/helpers.py,sha256=d1jOX0SNyqPc_3wr14xR25FfpqhMd4Ev7MNBOWlScc0,5581
 semantic_release/changelog/__init__.py,sha256=Bg6Xe5Vt32rWoMscW-hd4sUwiZqzWmsg4CD1EhMesMY,262
-semantic_release/changelog/context.py,sha256=YAtv_svSbRsRUqHfTbmfJRpE5xkOEUxmYaBINYJyXLE,1051
-semantic_release/changelog/release_history.py,sha256=ShzZpxTjhxka6TMbzOzYzG3EuCH8j3xjUQzll-FKcCo,6675
+semantic_release/changelog/context.py,sha256=8cbOv9cB9Ji7xjRn4-YUUHBfg9LLfSwmmXuZpqEmvns,1653
+semantic_release/changelog/release_history.py,sha256=jfkfnlATBqRpVLzxVi7wf2fO_bH_GOifQbaMO-mqDeY,6781
 semantic_release/changelog/template.py,sha256=JqZcjdozM9-059Sa8PfiHxYNeyZFa0jxk_beyRLv5sU,4640
-semantic_release/cli/__init__.py,sha256=gwAYhZO-4TR0tKCkQ4GqutWsL--0CII2_dcbrElI4M4,419
-semantic_release/cli/common.py,sha256=cVQUI7Uaac_nJ7VEXuJ7Q9pVJpuMVRvE7bBl_i96g20,1439
-semantic_release/cli/config.py,sha256=01BDXKi_LOMSozyTLcvztZnsu8ISwqea4cvHExQL4k8,21870
+semantic_release/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+semantic_release/cli/changelog_writer.py,sha256=Ga8QAq12kUD-fWWlrFoQCpn1pOzZmHnaCeZfFbBytFo,5027
+semantic_release/cli/cli_context.py,sha256=LApmhR6PTdHTPxs42KYMT_yYbaEXae-myuvio0mhI8w,3522
+semantic_release/cli/config.py,sha256=NAKOqLAc8NV0oL9XxAUPz2FWwS89Bjz8aKSCsRmQsvw,23661
 semantic_release/cli/const.py,sha256=S8oNNpSaKdZxcAs7PAKEjQHic0czoJBGd7XHo57FOzw,39
 semantic_release/cli/github_actions_output.py,sha256=Wy4jEIpSFgoMyJqq4FD7scIpgovivutFLZ7Fs4y2CUY,2110
 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=rNZwWucEbR2BjbmgHQa9R1nJk5Fu0Ph3U3wh-daH42Q,4197
-semantic_release/cli/commands/cli_context.py,sha256=fOLTUKb4UnZGQ6zVhftuvdfZ7fK7bDDIvj7Ud5yU98c,3443
+semantic_release/cli/commands/changelog.py,sha256=zincrvCBwMb7S3K3udRcArtQCuGkree-7IEzNtvF42A,3489
 semantic_release/cli/commands/generate_config.py,sha256=2xZOu3NpyhBp0pWr7d8ugKl_kjqQgpSsSMHq5wHTfrE,1699
-semantic_release/cli/commands/main.py,sha256=LuL-O0LGonI5fQTZn0AUtYv2Ei_CYyNqYHMF_wN4InI,2900
-semantic_release/cli/commands/publish.py,sha256=ZA7DuEGxZdIT9wUwP1S24qi1RdcKV-1FnYci-PvyXIg,1958
-semantic_release/cli/commands/version.py,sha256=lJ_DiD17dTXZ0hB8l_lBsL960dxuUmawR9dmr1KJjvA,27279
+semantic_release/cli/commands/main.py,sha256=kqO8bZw9Nv6T5QkIl53zzmH2rd4LuLoA8agweH0VYPY,4022
+semantic_release/cli/commands/publish.py,sha256=SZQlIewvqyIC14dkIIVVFetE0tPsKbO1cUyxnZsicrw,2845
+semantic_release/cli/commands/version.py,sha256=Saunh8juMDHJuPK8VcH0ZiUfYJduNODSwsAX2DjLki4,23809
 semantic_release/commit_parser/__init__.py,sha256=cv5HFBdw7OJd4Laj4Ex8ZZ5Tml8GwXgQcXW6Pasr2Ao,615
-semantic_release/commit_parser/_base.py,sha256=D2dY8dALV3QPK0XOLZru9btMW5dlx9YSmDIe3v5T0QA,3004
+semantic_release/commit_parser/_base.py,sha256=t-Z9ALgAe7aZpYXz1mk3Fe-uAvipgKdNrq4Okg_WW9c,3026
 semantic_release/commit_parser/angular.py,sha256=ERWeTBTFNIBOaTIopY4Vff0KbeFwrSQWbADe3smVW-8,4579
 semantic_release/commit_parser/emoji.py,sha256=M6zgqsXqegLK5FxZGyfsOPM3vOsJkPKVAjnGATOhwa4,3452
-semantic_release/commit_parser/scipy.py,sha256=uRNLSXH4LApxm8xSyUil23WVO3C8VEFRCnwTIKZbyQk,5879
+semantic_release/commit_parser/scipy.py,sha256=AH_GeMZ9hWiNQTL78bovpQy7mBeobGpUk5Shzyxxm6c,5951
 semantic_release/commit_parser/tag.py,sha256=SAop9INQvKOwktNmVypKFngd6xHmY_XZrLUWChUjz84,3353
 semantic_release/commit_parser/token.py,sha256=BB4ZCyt753CCaBFF95cQ4sFm6Au96wpO0YyTAWdcOvE,1609
 semantic_release/commit_parser/util.py,sha256=vLcVDErZrExM55jMffos0hyMbNVQoJ-PeeVDG1Ej51I,730
@@ -34,22 +35,22 @@ semantic_release/data/templates/CHANGELOG.md.j2,sha256=4SNA1uTM2_qLA_3QTbS8JHZi9
 semantic_release/data/templates/release_notes.md.j2,sha256=27uIHgG6iYmqdMaoWFP5LJRZcrO-3paqFzHHHsGpXXE,465
 semantic_release/hvcs/__init__.py,sha256=JwoaLOF-12L-OBo_9-tOXXhdiHKeVungA9865to2oZk,494
 semantic_release/hvcs/_base.py,sha256=9-iTqTPSbiEevKbCBP9K2hq4c-2T4wPbeLWe-kAxBzo,2607
-semantic_release/hvcs/bitbucket.py,sha256=tMpl69CbZSQ8cdgiqtIzf7WSz8OQwDInGpoq-9tQr3k,9216
-semantic_release/hvcs/gitea.py,sha256=CSItRSJU39hohO3oE-ohX65Er_s2nVrDqvfc7KQtmv8,11152
-semantic_release/hvcs/github.py,sha256=u-n1h3ivB8d-ca2Z8Jdgkhk-JTu-XONAqpiso8rKshk,18381
-semantic_release/hvcs/gitlab.py,sha256=ZVfeA2Uzl--6vVMJfJWXniPFzrsZ001Guzuu7AVSLOI,9414
-semantic_release/hvcs/remote_hvcs_base.py,sha256=plZkc5cSaiTxgIR5HhlEWrYoyWzzSXr-Jw3aXbMK_iA,6055
+semantic_release/hvcs/bitbucket.py,sha256=nqlOmeNda0sRSEBGWMluphy1KlpRTQrHV7itxf0IXE0,9266
+semantic_release/hvcs/gitea.py,sha256=XPwsjQ1XeSAdAsAjW7_QJdjxfTPJvW-Vnmoze7kCZP8,11919
+semantic_release/hvcs/github.py,sha256=TVXlviaXn2N_DBH0GxvIhTH-SQdn5mxbkjgu8rvb1y0,19148
+semantic_release/hvcs/gitlab.py,sha256=ia8Gjfm8mIctlEu5xqMPa-6t7YGSZQUbzKhKzgRuC3Q,9683
+semantic_release/hvcs/remote_hvcs_base.py,sha256=2TaPPp1NzsQjUMOKa0NjqkjYTxJpX245qGm7-GCrnx8,6085
 semantic_release/hvcs/token_auth.py,sha256=ZjT56-NIPB4OKIt1qwHCu1TavXnrWFIBl9ARlg56hgU,663
 semantic_release/hvcs/util.py,sha256=PNKXApgL2np9lpnKjAbo77toRgElLPXrbS1q7621waI,2886
 semantic_release/version/__init__.py,sha256=CLhtGQry9dLIij5XyRa9ZevxU_1p8tjMTSQ-K_GMpWM,270
-semantic_release/version/algorithm.py,sha256=-9ulTy1z4u-jUvbc-FrvEdFL7Omc3O3HhaPohjiCmm0,16854
+semantic_release/version/algorithm.py,sha256=ofx_bIWq6ptJVr-ekI11IzxzDEctDKFiVwaSmmmgRlE,16870
 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.8.3.dist-info/AUTHORS.rst,sha256=XOReVvpymEFUPsS2QPH97jlfJBVrxwS2eu8-jVAe4gk,230
-python_semantic_release-9.8.3.dist-info/LICENSE,sha256=NE85nszX252sdQdu0xgS9qwfYES0k8qS6gW3uO4jRGE,1083
-python_semantic_release-9.8.3.dist-info/METADATA,sha256=NfEykbj0ZB8WpYwC5CNepm16izRbP_O_8UfuXTqRRhs,5404
-python_semantic_release-9.8.3.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-python_semantic_release-9.8.3.dist-info/entry_points.txt,sha256=qojUBx_Ywf4u7KgP6NWlDaBDymZVUGQ7m5wF2duC2F0,95
-python_semantic_release-9.8.3.dist-info/top_level.txt,sha256=qYA24nyg3eP-ti5UW7Vuj2aXVmM0wqVHx4mREdRZNAA,17
-python_semantic_release-9.8.3.dist-info/RECORD,,
+python_semantic_release-9.8.4.dist-info/AUTHORS.rst,sha256=XOReVvpymEFUPsS2QPH97jlfJBVrxwS2eu8-jVAe4gk,230
+python_semantic_release-9.8.4.dist-info/LICENSE,sha256=NE85nszX252sdQdu0xgS9qwfYES0k8qS6gW3uO4jRGE,1083
+python_semantic_release-9.8.4.dist-info/METADATA,sha256=pfsnObyVM-vMXf-fME2dZbgH1yyiboC8gH805RJLvVE,5404
+python_semantic_release-9.8.4.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+python_semantic_release-9.8.4.dist-info/entry_points.txt,sha256=6bS6euSagjerp7onDtfI9_ZpczWreZF3gjHfGAegkbo,123
+python_semantic_release-9.8.4.dist-info/top_level.txt,sha256=qYA24nyg3eP-ti5UW7Vuj2aXVmM0wqVHx4mREdRZNAA,17
+python_semantic_release-9.8.4.dist-info/RECORD,,

python_semantic_release-9.8.4.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+psr = semantic_release.cli.commands.main:main
+semantic-release = semantic_release.cli.commands.main:main

semantic_release/__init__.py

@@ -24,7 +24,25 @@ from semantic_release.version import (
     tags_and_versions,
 )
 
-__version__ = "9.8.3"
+__version__ = "9.8.4"
+
+__all__ = [
+    "CommitParser",
+    "ParsedCommit",
+    "ParseError",
+    "ParseResult",
+    "ParseResultType",
+    "ParserOptions",
+    "LevelBump",
+    "SemanticReleaseBaseError",
+    "CommitParseError",
+    "InvalidConfiguration",
+    "InvalidVersion",
+    "Version",
+    "VersionTranslator",
+    "next_version",
+    "tags_and_versions",
+]
 
 
 def setup_hook(argv: list[str]) -> None:
@@ -36,6 +54,6 @@ def setup_hook(argv: list[str]) -> None:
     if len(argv) > 1 and any(
         cmd in argv for cmd in ["version", "publish", "changelog"]
     ):
-        from semantic_release.cli import main
+        from semantic_release.cli.commands.main import main
 
         main()

semantic_release/__main__.py

@@ -1,6 +1,6 @@
 import sys
 
-from semantic_release.cli import main
+from semantic_release.cli.commands.main import main
 
 if __name__ == "__main__":
     main(args=sys.argv[1:])

semantic_release/changelog/context.py

@@ -6,8 +6,32 @@ from typing import TYPE_CHECKING, Any, Callable
 if TYPE_CHECKING:
     from jinja2 import Environment
 
-    from semantic_release.changelog.release_history import ReleaseHistory
+    from semantic_release.changelog.release_history import Release, ReleaseHistory
     from semantic_release.hvcs._base import HvcsBase
+    from semantic_release.version.version import Version
+
+
+@dataclass
+class ReleaseNotesContext:
+    repo_name: str
+    repo_owner: str
+    hvcs_type: str
+    version: Version
+    release: Release
+    filters: tuple[Callable[..., Any], ...] = ()
+
+    def bind_to_environment(self, env: Environment) -> Environment:
+        env_globals = dict(
+            filter(lambda k_v: k_v[0] != "filters", self.__dict__.items())
+        )
+
+        for g, v in env_globals.items():
+            env.globals[g] = v
+
+        for f in self.filters:
+            env.filters[f.__name__] = f
+
+        return env
 
 
 @dataclass

semantic_release/changelog/release_history.py

@@ -99,6 +99,7 @@ class ReleaseHistory:
                         committer=committer,
                         tagged_date=tagged_date,
                         elements=defaultdict(list),
+                        version=the_version,
                     )
 
                     released.setdefault(the_version, release)
@@ -165,6 +166,7 @@ class ReleaseHistory:
                     "committer": committer,
                     "tagged_date": tagged_date,
                     "elements": self.unreleased,
+                    "version": version,
                 },
                 **self.released,
             },
@@ -183,3 +185,4 @@ class Release(TypedDict):
     committer: Actor
     tagged_date: datetime
     elements: dict[str, list[ParseResult]]
+    version: Version

semantic_release/cli/__init__.py

@@ -1,10 +0,0 @@
-from semantic_release.cli.commands.changelog import changelog
-from semantic_release.cli.commands.generate_config import generate_config
-from semantic_release.cli.commands.main import main
-from semantic_release.cli.commands.publish import publish
-from semantic_release.cli.commands.version import version
-
-main.add_command(changelog)
-main.add_command(generate_config)
-main.add_command(version)
-main.add_command(publish)

semantic_release/cli/changelog_writer.py

@@ -0,0 +1,169 @@
+from __future__ import annotations
+
+from logging import getLogger
+from os import listdir
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+# NOTE: use backport with newer API than stdlib
+from importlib_resources import files
+
+from semantic_release.changelog.context import (
+    ReleaseNotesContext,
+    make_changelog_context,
+)
+from semantic_release.changelog.template import environment, recursive_render
+from semantic_release.cli.util import noop_report
+
+if TYPE_CHECKING:
+    from jinja2 import Environment
+
+    from semantic_release.changelog.release_history import Release, ReleaseHistory
+    from semantic_release.cli.config import RuntimeContext
+    from semantic_release.hvcs._base import HvcsBase
+
+
+log = getLogger(__name__)
+
+
+def get_release_notes_template(template_dir: Path) -> str:
+    """Read the project's template for release notes, falling back to the default."""
+    fname = template_dir / ".release_notes.md.j2"
+    try:
+        return fname.read_text(encoding="utf-8")
+    except FileNotFoundError:
+        return (
+            files("semantic_release")
+            .joinpath("data/templates/release_notes.md.j2")
+            .read_text(encoding="utf-8")
+        )
+
+
+def render_default_changelog_file(template_env: Environment) -> str:
+    changelog_text = (
+        files("semantic_release")
+        .joinpath("data/templates/CHANGELOG.md.j2")
+        .read_text(encoding="utf-8")
+    )
+    template = template_env.from_string(changelog_text)
+    return template.render().rstrip()
+
+
+def render_release_notes(
+    release_notes_template: str,
+    template_env: Environment,
+) -> str:
+    template = template_env.from_string(release_notes_template)
+    return template.render().rstrip()
+
+
+def apply_user_changelog_template_directory(
+    template_dir: Path,
+    environment: Environment,
+    destination_dir: Path,
+    noop: bool = False,
+) -> list[str]:
+    if noop:
+        noop_report(
+            str.join(
+                " ",
+                [
+                    "would have recursively rendered the template directory",
+                    f"{template_dir!r} relative to {destination_dir!r}.",
+                    "Paths which would be modified by this operation cannot be",
+                    "determined in no-op mode.",
+                ],
+            )
+        )
+        return []
+
+    return recursive_render(
+        template_dir, environment=environment, _root_dir=destination_dir
+    )
+
+
+def write_default_changelog(
+    changelog_file: Path,
+    destination_dir: Path,
+    environment: Environment,
+    noop: bool = False,
+) -> str:
+    if noop:
+        noop_report(
+            str.join(
+                " ",
+                [
+                    "would have written your changelog to",
+                    str(changelog_file.relative_to(destination_dir)),
+                ],
+            )
+        )
+    else:
+        changelog_text = render_default_changelog_file(environment)
+        changelog_file.write_text(f"{changelog_text}\n", encoding="utf-8")
+
+    return str(changelog_file)
+
+
+def write_changelog_files(
+    runtime_ctx: RuntimeContext,
+    release_history: ReleaseHistory,
+    hvcs_client: HvcsBase,
+    noop: bool = False,
+) -> list[str]:
+    project_dir = Path(runtime_ctx.repo_dir)
+    template_dir = runtime_ctx.template_dir
+
+    changelog_context = make_changelog_context(
+        hvcs_client=hvcs_client,
+        release_history=release_history,
+    )
+
+    changelog_context.bind_to_environment(runtime_ctx.template_environment)
+
+    use_user_template_dir = bool(
+        # Directory exists and directory is not empty
+        template_dir.exists() and template_dir.is_dir() and listdir(template_dir)
+    )
+
+    if use_user_template_dir:
+        return apply_user_changelog_template_directory(
+            template_dir=template_dir,
+            environment=runtime_ctx.template_environment,
+            destination_dir=project_dir,
+            noop=noop,
+        )
+
+    log.info("No contents found in %r, using default changelog template", template_dir)
+    return [
+        write_default_changelog(
+            changelog_file=runtime_ctx.changelog_file,
+            destination_dir=project_dir,
+            environment=runtime_ctx.template_environment,
+            noop=noop,
+        )
+    ]
+
+
+def generate_release_notes(
+    hvcs_client: HvcsBase,
+    release: Release,
+    template_dir: Path,
+) -> str:
+    release_notes_env = ReleaseNotesContext(
+        repo_name=hvcs_client.repo_name,
+        repo_owner=hvcs_client.owner,
+        hvcs_type=hvcs_client.__class__.__name__.lower(),
+        version=release["version"],
+        release=release,
+        filters=(*hvcs_client.get_changelog_context_filters(),),
+    ).bind_to_environment(
+        # Use a new, non-configurable environment for release notes -
+        # not user-configurable at the moment
+        environment(template_dir=template_dir)
+    )
+
+    return render_release_notes(
+        release_notes_template=get_release_notes_template(template_dir),
+        template_env=release_notes_env,
+    )

semantic_release/cli/{commands/cli_context.py → cli_context.py}

@@ -14,7 +14,11 @@ from semantic_release.cli.config import (
     RuntimeContext,
 )
 from semantic_release.cli.util import load_raw_config_file, rprint
-from semantic_release.errors import InvalidConfiguration, NotAReleaseBranch
+from semantic_release.errors import (
+    DetachedHeadGitError,
+    InvalidConfiguration,
+    NotAReleaseBranch,
+)
 
 if TYPE_CHECKING:
     from semantic_release.cli.config import GlobalCommandLineOptions
@@ -58,7 +62,7 @@ class CliContextObj:
 
         try:
             if was_conf_file_user_provided and not conf_file_exists:
-                raise FileNotFoundError(
+                raise FileNotFoundError(  # noqa: TRY301
                     f"File {self.global_opts.config_file} does not exist"
                 )
 
@@ -75,7 +79,7 @@ class CliContextObj:
                 raw_config,
                 global_cli_options=self.global_opts,
             )
-        except NotAReleaseBranch as exc:
+        except (DetachedHeadGitError, NotAReleaseBranch) as exc:
             rprint(f"[bold {'red' if self.global_opts.strict else 'orange1'}]{exc!s}")
             # If not strict, exit 0 so other processes can continue. For example, in
             # multibranch CI it might be desirable to run a non-release branch's pipeline

semantic_release/cli/commands/changelog.py

@@ -1,28 +1,50 @@
 from __future__ import annotations
 
 import logging
-import os
 from typing import TYPE_CHECKING
 
 import click
+from git import Repo
 
-from semantic_release.changelog import ReleaseHistory, recursive_render
-from semantic_release.changelog.context import make_changelog_context
-from semantic_release.cli.common import (
-    get_release_notes_template,
-    render_default_changelog_file,
-    render_release_notes,
+from semantic_release.changelog import ReleaseHistory
+from semantic_release.cli.changelog_writer import (
+    generate_release_notes,
+    write_changelog_files,
 )
 from semantic_release.cli.util import noop_report
 from semantic_release.hvcs.remote_hvcs_base import RemoteHvcsBase
 
 if TYPE_CHECKING:
-    from semantic_release.cli.commands.cli_context import CliContextObj
-    from semantic_release.version import Version
+    from semantic_release.cli.cli_context import CliContextObj
+
 
 log = logging.getLogger(__name__)
 
 
+def post_release_notes(
+    release_tag: str,
+    release_notes: str,
+    prerelease: bool,
+    hvcs_client: RemoteHvcsBase,
+    noop: bool = False,
+) -> None:
+    if noop:
+        noop_report(
+            str.join(
+                "\n",
+                [
+                    f"would have posted the following release notes for tag {release_tag}:",
+                    release_notes,
+                ],
+            )
+        )
+        return
+
+    hvcs_client.create_or_update_release(
+        release_tag, f"{release_notes}\n", prerelease=prerelease
+    )
+
+
 @click.command(
     short_help="Generate a changelog",
     context_settings={
@@ -36,86 +58,72 @@ log = logging.getLogger(__name__)
     help="Post the generated release notes to the remote VCS's release for this tag",
 )
 @click.pass_obj
-def changelog(cli_ctx: CliContextObj, release_tag: str | None = None) -> None:
+def changelog(cli_ctx: CliContextObj, release_tag: str | None) -> None:
     """Generate and optionally publish a changelog for your project"""
     ctx = click.get_current_context()
     runtime = cli_ctx.runtime_ctx
-    repo = runtime.repo
-    parser = runtime.commit_parser
     translator = runtime.version_translator
     hvcs_client = runtime.hvcs_client
-    env = runtime.template_environment
-    template_dir = runtime.template_dir
-    changelog_file = runtime.changelog_file
-    changelog_excluded_commit_patterns = runtime.changelog_excluded_commit_patterns
-
-    rh = ReleaseHistory.from_git_history(
-        repo=repo,
-        translator=translator,
-        commit_parser=parser,
-        exclude_commit_patterns=changelog_excluded_commit_patterns,
-    )
-    changelog_context = make_changelog_context(
-        hvcs_client=hvcs_client, release_history=rh
+
+    with Repo(str(runtime.repo_dir)) as git_repo:
+        release_history = ReleaseHistory.from_git_history(
+            repo=git_repo,
+            translator=translator,
+            commit_parser=runtime.commit_parser,
+            exclude_commit_patterns=runtime.changelog_excluded_commit_patterns,
+        )
+
+    write_changelog_files(
+        runtime_ctx=runtime,
+        release_history=release_history,
+        hvcs_client=hvcs_client,
+        noop=runtime.global_cli_options.noop,
     )
-    changelog_context.bind_to_environment(env)
-
-    if not os.path.exists(template_dir):
-        log.info("Path %r not found, using default changelog template", template_dir)
-        if runtime.global_cli_options.noop:
-            noop_report(
-                "would have written your changelog to "
-                + str(changelog_file.relative_to(repo.working_dir))
-            )
-        else:
-            changelog_text = render_default_changelog_file(env)
-            changelog_file.write_text(f"{changelog_text}\n", encoding="utf-8")
-
-    else:
-        if runtime.global_cli_options.noop:
-            noop_report(
-                f"would have recursively rendered the template directory "
-                f"{template_dir!r} relative to {repo.working_dir!r}"
-            )
-        else:
-            recursive_render(template_dir, environment=env, _root_dir=repo.working_dir)
 
-    if release_tag and isinstance(hvcs_client, RemoteHvcsBase):
-        if runtime.global_cli_options.noop:
-            noop_report(
-                f"would have posted changelog to the release for tag {release_tag}"
-            )
+    if not release_tag:
+        return
 
-        # note: the following check ensures 'version is not None', but mypy can't follow
-        version: Version = translator.from_tag(release_tag)  # type: ignore[assignment]
-        if not version:
-            ctx.fail(
-                f"Tag {release_tag!r} doesn't match tag format "
-                f"{translator.tag_format!r}"
-            )
+    if not isinstance(hvcs_client, RemoteHvcsBase):
+        click.echo(
+            "Remote does not support releases. Skipping release notes update...",
+            err=True,
+        )
+        return
 
-        try:
-            release = rh.released[version]
-        except KeyError:
-            ctx.fail(f"tag {release_tag} not in release history")
-
-        template = get_release_notes_template(template_dir)
-        release_notes = render_release_notes(
-            release_notes_template=template,
-            template_environment=env,
-            version=version,
-            release=release,
+    if not (version := translator.from_tag(release_tag)):
+        click.echo(
+            str.join(
+                " ",
+                [
+                    f"Tag {release_tag!r} does not match the tag format",
+                    repr(translator.tag_format),
+                ],
+            ),
+            err=True,
         )
+        ctx.exit(1)
 
-        if runtime.global_cli_options.noop:
-            noop_report(
-                "would have posted the following release notes:\n" + release_notes
-            )
-        else:
-            try:
-                hvcs_client.create_or_update_release(
-                    release_tag, f"{release_notes}\n", prerelease=version.is_prerelease
-                )
-            except Exception as e:
-                log.exception(e)
-                ctx.fail(str(e))
+    try:
+        release = release_history.released[version]
+    except KeyError:
+        click.echo(f"tag {release_tag} not in release history", err=True)
+        ctx.exit(2)
+
+    release_notes = generate_release_notes(
+        hvcs_client,
+        release,
+        template_dir=runtime.template_dir,
+    )
+
+    try:
+        post_release_notes(
+            release_tag=release_tag,
+            release_notes=release_notes,
+            prerelease=version.is_prerelease,
+            hvcs_client=hvcs_client,
+            noop=runtime.global_cli_options.noop,
+        )
+    except Exception as e:
+        log.exception(e)
+        click.echo("Failed to post release notes to remote", err=True)
+        ctx.exit(1)