python-semantic-release 10.3.0__tar.gz → 10.3.1__tar.gz

{python_semantic_release-10.3.0 → python_semantic_release-10.3.1}/PKG-INFO

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

{python_semantic_release-10.3.0 → python_semantic_release-10.3.1}/docs/configuration/automatic-releases/github-actions.rst

@@ -19,6 +19,14 @@ There are two official GitHub Actions for Python Semantic Release:
     It is used to upload files, such as distribution artifacts and other assets,
     to a GitHub release.
 
+Included in this documentation are some recommended examples below if you want to get
+started quickly. These examples are not exhaustive and you will need to adjust them
+for your specific project needs especially if you are using a monorepo.
+
+- :ref:`GitHub Actions Example Workflows <gh_actions-examples>`
+
+- :ref:`GitHub Actions with Monorepos <gh_actions-monorepo>`
+
 .. note::
   These GitHub Actions are only simplified wrappers around the
   python-semantic-release CLI. Ultimately, they download and install the
@@ -925,14 +933,14 @@ to the GitHub Release Assets as well.
           - name: Action | Semantic Version Release
             id: release
             # Adjust tag with desired version if applicable.
-            uses: python-semantic-release/python-semantic-release@v10.3.0
+            uses: python-semantic-release/python-semantic-release@v10.3.1
             with:
               github_token: ${{ secrets.GITHUB_TOKEN }}
               git_committer_name: "github-actions"
               git_committer_email: "actions@users.noreply.github.com"
 
           - name: Publish | Upload to GitHub Release Assets
-            uses: python-semantic-release/publish-action@v10.3.0
+            uses: python-semantic-release/publish-action@v10.3.1
             if: steps.release.outputs.released == 'true'
             with:
               github_token: ${{ secrets.GITHUB_TOKEN }}
@@ -1031,7 +1039,7 @@ The equivalent GitHub Action configuration would be:
 
   - name: Action | Semantic Version Release
     # Adjust tag with desired version if applicable.
-    uses: python-semantic-release/python-semantic-release@v10.3.0
+    uses: python-semantic-release/python-semantic-release@v10.3.1
     with:
       github_token: ${{ secrets.GITHUB_TOKEN }}
       force: patch
@@ -1090,14 +1098,14 @@ Publish Action.
 
         - name: Release submodule 1
           id: release-submod-1
-          uses: python-semantic-release/python-semantic-release@v10.3.0
+          uses: python-semantic-release/python-semantic-release@v10.3.1
           with:
             directory: ${{ env.SUBMODULE_1_DIR }}
             github_token: ${{ secrets.GITHUB_TOKEN }}
 
         - name: Release submodule 2
           id: release-submod-2
-          uses: python-semantic-release/python-semantic-release@v10.3.0
+          uses: python-semantic-release/python-semantic-release@v10.3.1
           with:
             directory: ${{ env.SUBMODULE_2_DIR }}
             github_token: ${{ secrets.GITHUB_TOKEN }}
@@ -1109,7 +1117,7 @@ Publish Action.
         # ------------------------------------------------------------------- #
 
         - name: Publish | Upload package 1 to GitHub Release Assets
-          uses: python-semantic-release/publish-action@v10.3.0
+          uses: python-semantic-release/publish-action@v10.3.1
           if: steps.release-submod-1.outputs.released == 'true'
           with:
             directory: ${{ env.SUBMODULE_1_DIR }}
@@ -1117,7 +1125,7 @@ Publish Action.
             tag: ${{ steps.release-submod-1.outputs.tag }}
 
         - name: Publish | Upload package 2 to GitHub Release Assets
-          uses: python-semantic-release/publish-action@v10.3.0
+          uses: python-semantic-release/publish-action@v10.3.1
           if: steps.release-submod-2.outputs.released == 'true'
           with:
             directory: ${{ env.SUBMODULE_2_DIR }}

{python_semantic_release-10.3.0 → python_semantic_release-10.3.1}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-semantic-release"
-version = "10.3.0"
+version = "10.3.1"
 description = "Automatic Semantic Versioning for Python projects"
 requires-python = ">=3.8"
 license = { text = "MIT" }

{python_semantic_release-10.3.0 → python_semantic_release-10.3.1}/src/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
@@ -468,9 +471,16 @@ def version(  # noqa: C901
     no_verify = runtime.no_git_verify
     opts = runtime.global_cli_options
     gha_output = VersionGitHubActionsOutput(
-        hvcs_client
-        if isinstance(hvcs_client, Github)
-        else Github(hvcs_client.remote_url(use_token=False)),
+        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,
     )
 

{python_semantic_release-10.3.0 → python_semantic_release-10.3.1}/src/semantic_release/cli/github_actions_output.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import os
+from enum import Enum
 from re import compile as regexp
 from typing import TYPE_CHECKING
 
@@ -13,12 +14,18 @@ if TYPE_CHECKING:
     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,
@@ -26,6 +33,7 @@ class VersionGitHubActionsOutput:
         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
@@ -104,10 +112,11 @@ class VersionGitHubActionsOutput:
             missing.add("version")
         if self.released is None:
             missing.add("released")
-        if self.released and self.commit_sha is None:
-            missing.add("commit_sha")
-        if self.released and self.release_notes is None:
-            missing.add("release_notes")
+        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(