python-semantic-release 10.2.0__py3-none-any.whl → 10.3.1__py3-none-any.whl

{python_semantic_release-10.2.0.dist-info → python_semantic_release-10.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-semantic-release
-Version: 10.2.0
+Version: 10.3.1
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT
@@ -88,5 +88,5 @@ The usage information and examples for this GitHub Action is available under
 the `GitHub Actions section`_ of `python-semantic-release.readthedocs.io`_.
 
 .. _python-semantic-release: https://pypi.org/project/python-semantic-release/
-.. _python-semantic-release.readthedocs.io: https://python-semantic-release.readthedocs.io/en/latest/
-.. _GitHub Actions section: https://python-semantic-release.readthedocs.io/en/latest/automatic-releases/github-actions.html
+.. _python-semantic-release.readthedocs.io: https://python-semantic-release.readthedocs.io/en/stable/
+.. _GitHub Actions section: https://python-semantic-release.readthedocs.io/en/stable/configuration/automatic-releases/github-actions.html

{python_semantic_release-10.2.0.dist-info → python_semantic_release-10.3.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-python_semantic_release-10.2.0.dist-info/licenses/LICENSE,sha256=NE85nszX252sdQdu0xgS9qwfYES0k8qS6gW3uO4jRGE,1083
+python_semantic_release-10.3.1.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
@@ -17,15 +17,15 @@ semantic_release/cli/changelog_writer.py,sha256=2jP5b0LK61Y2tb22GQSFFmwHwXd2Wjbo
 semantic_release/cli/cli_context.py,sha256=Nop71LdVCJOeSUHgTXunMyK3xAu_QKQC2cRp1QBVkX0,4134
 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/github_actions_output.py,sha256=uiIZKVq3Rr2Q_Xt8UlpCszrc-HBB-2f9HGxB7KoF2qE,5209
 semantic_release/cli/masking_filter.py,sha256=GsTyaoZbUVJLXVMqeXhCttXK84UnBQ8cNDSHxd52sOc,3218
-semantic_release/cli/util.py,sha256=4hiqvMzuUzMJ0-vYn-mYoB5nctBHjL45EhLqApbc2DQ,3729
+semantic_release/cli/util.py,sha256=4rf4xDHb7l-XpdcFNtslFz1xHslnBu6cTgWHXVnQXQs,3746
 semantic_release/cli/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 semantic_release/cli/commands/changelog.py,sha256=wJfd4VVfrGnu2jnIpG25cdVcbXIX-ElKl3b2jdtPPa0,5391
 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=d72k2YVkynbBcjFPbWJr80PjjYE7JMd_btaL4baByaM,25762
+semantic_release/cli/commands/version.py,sha256=Mf0lulFWKp4VIGAq-sTBnLGO60xpe6skmUbVdhUUKqg,26681
 semantic_release/commit_parser/__init__.py,sha256=6euiDgj9bwOx1rP96vUjq090usviXkbo7OVOnRBGfcw,742
 semantic_release/commit_parser/_base.py,sha256=DLsHnbXG-39JkUbcnsBCSV2GmV35w1rasyoMhK8G0UE,3058
 semantic_release/commit_parser/angular.py,sha256=MY_fo9F4EZ-ac8wYzBR0uD94O5Li2D-8zEMR01wss4c,18534
@@ -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.2.0.dist-info/METADATA,sha256=_wRj0vN8sxY4OE7ls1MbS9kWhFLnT1gD2AWwTjp-D-A,3913
-python_semantic_release-10.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-python_semantic_release-10.2.0.dist-info/entry_points.txt,sha256=kzkCyDJsMOwgpFwEWKE9wxN1tXaUP6g6GIO4xtc0QuE,162
-python_semantic_release-10.2.0.dist-info/top_level.txt,sha256=qYA24nyg3eP-ti5UW7Vuj2aXVmM0wqVHx4mREdRZNAA,17
-python_semantic_release-10.2.0.dist-info/RECORD,,
+python_semantic_release-10.3.1.dist-info/METADATA,sha256=ALVaRulT0o1-464ffA0WQMrjKorzp-2GJCIg0z9B-8Q,3927
+python_semantic_release-10.3.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+python_semantic_release-10.3.1.dist-info/entry_points.txt,sha256=kzkCyDJsMOwgpFwEWKE9wxN1tXaUP6g6GIO4xtc0QuE,162
+python_semantic_release-10.3.1.dist-info/top_level.txt,sha256=qYA24nyg3eP-ti5UW7Vuj2aXVmM0wqVHx4mREdRZNAA,17
+python_semantic_release-10.3.1.dist-info/RECORD,,

semantic_release/cli/commands/version.py

@@ -18,7 +18,10 @@ from semantic_release.cli.changelog_writer import (
     generate_release_notes,
     write_changelog_files,
 )
-from semantic_release.cli.github_actions_output import VersionGitHubActionsOutput
+from semantic_release.cli.github_actions_output import (
+    PersistenceMode,
+    VersionGitHubActionsOutput,
+)
 from semantic_release.cli.util import noop_report, rprint
 from semantic_release.const import DEFAULT_SHELL, DEFAULT_VERSION
 from semantic_release.enums import LevelBump
@@ -30,6 +33,7 @@ from semantic_release.errors import (
 )
 from semantic_release.gitproject import GitProject
 from semantic_release.globals import logger
+from semantic_release.hvcs.github import Github
 from semantic_release.hvcs.remote_hvcs_base import RemoteHvcsBase
 from semantic_release.version.algorithm import (
     next_version,
@@ -466,7 +470,19 @@ def version(  # noqa: C901
     major_on_zero = runtime.major_on_zero
     no_verify = runtime.no_git_verify
     opts = runtime.global_cli_options
-    gha_output = VersionGitHubActionsOutput(released=False)
+    gha_output = VersionGitHubActionsOutput(
+        gh_client=(
+            hvcs_client
+            if isinstance(hvcs_client, Github)
+            else Github(hvcs_client.remote_url(use_token=False))
+        ),
+        mode=(
+            PersistenceMode.TEMPORARY
+            if opts.noop or (not commit_changes and not create_tag)
+            else PersistenceMode.PERMANENT
+        ),
+        released=False,
+    )
 
     forced_level_bump = None if not force_level else LevelBump.from_string(force_level)
     prerelease = is_forced_prerelease(
@@ -572,6 +588,12 @@ def version(  # noqa: C901
     if print_only or print_only_tag:
         return
 
+    # TODO: need a better way as this is inconsistent if releasing older version patches
+    if last_release := last_released(config.repo_dir, tag_format=config.tag_format):
+        # If we have a last release, we can set the previous version for the
+        # GitHub Actions output
+        gha_output.prev_version = last_release[1]
+
     with Repo(str(runtime.repo_dir)) as git_repo:
         release_history = ReleaseHistory.from_git_history(
             repo=git_repo,
@@ -641,6 +663,29 @@ def version(  # noqa: C901
             click.echo("Build failed, aborting release", err=True)
             ctx.exit(1)
 
+    license_cfg = runtime.project_metadata.get(
+        "license-expression",
+        runtime.project_metadata.get(
+            "license",
+            "",
+        ),
+    )
+
+    license_cfg = "" if not isinstance(license_cfg, (str, dict)) else license_cfg
+    license_cfg = (
+        license_cfg.get("text", "") if isinstance(license_cfg, dict) else license_cfg
+    )
+
+    gha_output.release_notes = release_notes = generate_release_notes(
+        hvcs_client,
+        release=release_history.released[new_version],
+        template_dir=runtime.template_dir,
+        history=release_history,
+        style=runtime.changelog_style,
+        mask_initial_release=runtime.changelog_mask_initial_release,
+        license_name="" if not isinstance(license_cfg, str) else license_cfg,
+    )
+
     project = GitProject(
         directory=runtime.repo_dir,
         commit_author=runtime.commit_author,
@@ -676,6 +721,9 @@ def version(  # noqa: C901
             noop=opts.noop,
         )
 
+        with Repo(str(runtime.repo_dir)) as git_repo:
+            gha_output.commit_sha = git_repo.head.commit.hexsha
+
     if push_changes:
         remote_url = runtime.hvcs_client.remote_url(
             use_token=not runtime.ignore_token_for_push
@@ -710,33 +758,6 @@ def version(  # noqa: C901
         logger.info("Remote does not support releases. Skipping release creation...")
         return
 
-    license_cfg = runtime.project_metadata.get(
-        "license-expression",
-        runtime.project_metadata.get(
-            "license",
-            "",
-        ),
-    )
-
-    if not isinstance(license_cfg, (str, dict)) or license_cfg is None:
-        license_cfg = ""
-
-    license_name = (
-        license_cfg.get("text", "")
-        if isinstance(license_cfg, dict)
-        else license_cfg or ""
-    )
-
-    release_notes = generate_release_notes(
-        hvcs_client,
-        release=release_history.released[new_version],
-        template_dir=runtime.template_dir,
-        history=release_history,
-        style=runtime.changelog_style,
-        mask_initial_release=runtime.changelog_mask_initial_release,
-        license_name=license_name,
-    )
-
     exception: Exception | None = None
     help_message = ""
     try:

semantic_release/cli/github_actions_output.py

@@ -1,21 +1,44 @@
 from __future__ import annotations
 
 import os
+from enum import Enum
+from re import compile as regexp
+from typing import TYPE_CHECKING
 
 from semantic_release.globals import logger
 from semantic_release.version.version import Version
 
+if TYPE_CHECKING:
+    from typing import Any
+
+    from semantic_release.hvcs.github import Github
+
+
+class PersistenceMode(Enum):
+    TEMPORARY = "temporary"
+    PERMANENT = "permanent"
+
 
 class VersionGitHubActionsOutput:
     OUTPUT_ENV_VAR = "GITHUB_OUTPUT"
 
     def __init__(
         self,
+        gh_client: Github,
+        mode: PersistenceMode = PersistenceMode.PERMANENT,
         released: bool | None = None,
         version: Version | None = None,
+        commit_sha: str | None = None,
+        release_notes: str | None = None,
+        prev_version: Version | None = None,
     ) -> None:
+        self._gh_client = gh_client
+        self._mode = mode
         self._released = released
         self._version = version
+        self._commit_sha = commit_sha
+        self._release_notes = release_notes
+        self._prev_version = prev_version
 
     @property
     def released(self) -> bool | None:
@@ -23,7 +46,7 @@ class VersionGitHubActionsOutput:
 
     @released.setter
     def released(self, value: bool) -> None:
-        if type(value) is not bool:
+        if not isinstance(value, bool):
             raise TypeError("output 'released' is boolean")
         self._released = value
 
@@ -33,7 +56,7 @@ class VersionGitHubActionsOutput:
 
     @version.setter
     def version(self, value: Version) -> None:
-        if type(value) is not Version:
+        if not isinstance(value, Version):
             raise TypeError("output 'released' should be a Version")
         self._version = value
 
@@ -45,26 +68,86 @@ class VersionGitHubActionsOutput:
     def is_prerelease(self) -> bool | None:
         return self.version.is_prerelease if self.version is not None else None
 
+    @property
+    def commit_sha(self) -> str | None:
+        return self._commit_sha if self._commit_sha else None
+
+    @commit_sha.setter
+    def commit_sha(self, value: str) -> None:
+        if not isinstance(value, str):
+            raise TypeError("output 'commit_sha' should be a string")
+
+        if not regexp(r"^[0-9a-f]{40}$").match(value):
+            raise ValueError(
+                "output 'commit_sha' should be a valid 40-hex-character SHA"
+            )
+
+        self._commit_sha = value
+
+    @property
+    def release_notes(self) -> str | None:
+        return self._release_notes if self._release_notes else None
+
+    @release_notes.setter
+    def release_notes(self, value: str) -> None:
+        if not isinstance(value, str):
+            raise TypeError("output 'release_notes' should be a string")
+        self._release_notes = value
+
+    @property
+    def prev_version(self) -> Version | None:
+        if not self.released:
+            return self.version
+        return self._prev_version if self._prev_version else None
+
+    @prev_version.setter
+    def prev_version(self, value: Version) -> None:
+        if not isinstance(value, Version):
+            raise TypeError("output 'prev_version' should be a Version")
+        self._prev_version = value
+
     def to_output_text(self) -> str:
-        missing = set()
+        missing: set[str] = set()
         if self.version is None:
             missing.add("version")
         if self.released is None:
             missing.add("released")
+        if self.released:
+            if self.release_notes is None:
+                missing.add("release_notes")
+            if self._mode is PersistenceMode.PERMANENT and self.commit_sha is None:
+                missing.add("commit_sha")
 
         if missing:
             raise ValueError(
                 f"some required outputs were not set: {', '.join(missing)}"
             )
 
-        outputs = {
+        output_values: dict[str, Any] = {
             "released": str(self.released).lower(),
             "version": str(self.version),
             "tag": self.tag,
             "is_prerelease": str(self.is_prerelease).lower(),
+            "link": self._gh_client.create_release_url(self.tag) if self.tag else "",
+            "previous_version": str(self.prev_version) if self.prev_version else "",
+            "commit_sha": self.commit_sha if self.commit_sha else "",
         }
 
-        return str.join("", [f"{key}={value!s}\n" for key, value in outputs.items()])
+        multiline_output_values: dict[str, str] = {
+            "release_notes": self.release_notes if self.release_notes else "",
+        }
+
+        output_lines = [
+            *[f"{key}={value!s}{os.linesep}" for key, value in output_values.items()],
+            *[
+                f"{key}<<EOF{os.linesep}{value}EOF{os.linesep}"
+                if value
+                else f"{key}={os.linesep}"
+                for key, value in multiline_output_values.items()
+            ],
+        ]
+
+        return str.join("", output_lines)
 
     def write_if_possible(self, filename: str | None = None) -> None:
         output_file = filename or os.getenv(self.OUTPUT_ENV_VAR)
@@ -72,5 +155,5 @@ class VersionGitHubActionsOutput:
             logger.info("not writing GitHub Actions output, as no file specified")
             return
 
-        with open(output_file, "a", encoding="utf-8") as f:
-            f.write(self.to_output_text())
+        with open(output_file, "ab") as f:
+            f.write(self.to_output_text().encode("utf-8"))

semantic_release/cli/util.py

@@ -9,6 +9,7 @@ from textwrap import dedent, indent
 from typing import Any
 
 import rich
+import rich.markup
 import tomlkit
 from tomlkit.exceptions import TOMLKitError
 
@@ -26,8 +27,7 @@ def noop_report(msg: str) -> None:
     Rich-prints a msg with a standard prefix to report when an action is not being
     taken due to a "noop" flag
     """
-    fullmsg = "[bold cyan][:shield: NOP] " + msg
-    rprint(fullmsg)
+    rprint(f"[bold cyan][:shield: NOP] {rich.markup.escape(msg)}")
 
 
 def indented(msg: str, prefix: str = " " * 4) -> str: