python-semantic-release 9.7.3__py3-none-any.whl → 9.8.1__py3-none-any.whl

{python_semantic_release-9.7.3.dist-info → python_semantic_release-9.8.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-semantic-release
-Version: 9.7.3
+Version: 9.8.1
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT
@@ -37,7 +37,7 @@ 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.3 ; extra == 'dev'
+Requires-Dist: ruff ==0.4.4 ; extra == 'dev'
 Provides-Extra: docs
 Requires-Dist: Sphinx ~=6.0 ; extra == 'docs'
 Requires-Dist: sphinxcontrib-apidoc ==0.5.0 ; extra == 'docs'

{python_semantic_release-9.7.3.dist-info → python_semantic_release-9.8.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-semantic_release/__init__.py,sha256=AZQWQT9mepV90IGGzHfKVqLS8S9iWbQ8KQInlRZaCAo,870
+semantic_release/__init__.py,sha256=lXpPMb5uIiSyQhUCbxSLX5FuhekMzxQT4tW-ESrktBI,870
 semantic_release/__main__.py,sha256=vXOARLV7KHeVXgpOMU0Q-8wovpdsOrtTsycxulI5xIE,106
 semantic_release/const.py,sha256=Z1o2QNh60wSLeF-_1TemMBjU3ZXbV0XghnUFsbTVfOs,831
 semantic_release/enums.py,sha256=D5B_reQGGKQQT22HO5PUtvn2Bok3fkht6TfJtXkmAUg,1020
@@ -10,7 +10,7 @@ semantic_release/changelog/release_history.py,sha256=ShzZpxTjhxka6TMbzOzYzG3EuCH
 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=NhXw_qi-KElU2xd_mw1MrBo3zgstzn1c0ZOCSQNTu8s,21769
+semantic_release/cli/config.py,sha256=01BDXKi_LOMSozyTLcvztZnsu8ISwqea4cvHExQL4k8,21870
 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
@@ -21,7 +21,7 @@ semantic_release/cli/commands/cli_context.py,sha256=fOLTUKb4UnZGQ6zVhftuvdfZ7fK7
 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=cURNIwQrdrENnUwMVpSQ42kD80TZ5uqy45Ia3nBLCQc,26160
+semantic_release/cli/commands/version.py,sha256=lJ_DiD17dTXZ0hB8l_lBsL960dxuUmawR9dmr1KJjvA,27279
 semantic_release/commit_parser/__init__.py,sha256=cv5HFBdw7OJd4Laj4Ex8ZZ5Tml8GwXgQcXW6Pasr2Ao,615
 semantic_release/commit_parser/_base.py,sha256=D2dY8dALV3QPK0XOLZru9btMW5dlx9YSmDIe3v5T0QA,3004
 semantic_release/commit_parser/angular.py,sha256=ERWeTBTFNIBOaTIopY4Vff0KbeFwrSQWbADe3smVW-8,4579
@@ -36,8 +36,8 @@ semantic_release/hvcs/__init__.py,sha256=JwoaLOF-12L-OBo_9-tOXXhdiHKeVungA9865to
 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=34ZMGttmqcTcY6_D-SRn-HxUJxNT4WwBNEwYlsHC420,18287
-semantic_release/hvcs/gitlab.py,sha256=JtHWBaNGSMB8MTiznEhvuMm_M8lLceZPaGndzOx39Vk,6249
+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/token_auth.py,sha256=ZjT56-NIPB4OKIt1qwHCu1TavXnrWFIBl9ARlg56hgU,663
 semantic_release/hvcs/util.py,sha256=PNKXApgL2np9lpnKjAbo77toRgElLPXrbS1q7621waI,2886
@@ -46,10 +46,10 @@ semantic_release/version/algorithm.py,sha256=-9ulTy1z4u-jUvbc-FrvEdFL7Omc3O3HhaP
 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.7.3.dist-info/AUTHORS.rst,sha256=XOReVvpymEFUPsS2QPH97jlfJBVrxwS2eu8-jVAe4gk,230
-python_semantic_release-9.7.3.dist-info/LICENSE,sha256=NE85nszX252sdQdu0xgS9qwfYES0k8qS6gW3uO4jRGE,1083
-python_semantic_release-9.7.3.dist-info/METADATA,sha256=oTsw-ui914QMQuaBDHR-XOaqFBOL3l3zJ9wajIjGCtY,5404
-python_semantic_release-9.7.3.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-python_semantic_release-9.7.3.dist-info/entry_points.txt,sha256=qojUBx_Ywf4u7KgP6NWlDaBDymZVUGQ7m5wF2duC2F0,95
-python_semantic_release-9.7.3.dist-info/top_level.txt,sha256=qYA24nyg3eP-ti5UW7Vuj2aXVmM0wqVHx4mREdRZNAA,17
-python_semantic_release-9.7.3.dist-info/RECORD,,
+python_semantic_release-9.8.1.dist-info/AUTHORS.rst,sha256=XOReVvpymEFUPsS2QPH97jlfJBVrxwS2eu8-jVAe4gk,230
+python_semantic_release-9.8.1.dist-info/LICENSE,sha256=NE85nszX252sdQdu0xgS9qwfYES0k8qS6gW3uO4jRGE,1083
+python_semantic_release-9.8.1.dist-info/METADATA,sha256=umroH8O83cP7YCxNjNYcTkzyx2I2ASj3l36gqSZMkVY,5404
+python_semantic_release-9.8.1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+python_semantic_release-9.8.1.dist-info/entry_points.txt,sha256=qojUBx_Ywf4u7KgP6NWlDaBDymZVUGQ7m5wF2duC2F0,95
+python_semantic_release-9.8.1.dist-info/top_level.txt,sha256=qYA24nyg3eP-ti5UW7Vuj2aXVmM0wqVHx4mREdRZNAA,17
+python_semantic_release-9.8.1.dist-info/RECORD,,

semantic_release/__init__.py

@@ -24,7 +24,7 @@ from semantic_release.version import (
     tags_and_versions,
 )
 
-__version__ = "9.7.3"
+__version__ = "9.8.1"
 
 
 def setup_hook(argv: list[str]) -> None:

semantic_release/cli/commands/version.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import logging
 import os
 import subprocess
+import sys
 from contextlib import nullcontext
 from datetime import datetime
 from typing import TYPE_CHECKING
@@ -156,6 +157,40 @@ def shell(
     )
 
 
+def is_windows() -> bool:
+    return sys.platform == "win32"
+
+
+def get_windows_env() -> Mapping[str, str | None]:
+    return {
+        environment_variable: os.getenv(environment_variable, None)
+        for environment_variable in (
+            "ALLUSERSAPPDATA",
+            "ALLUSERSPROFILE",
+            "APPDATA",
+            "COMMONPROGRAMFILES",
+            "COMMONPROGRAMFILES(x86)",
+            "DEFAULTUSERPROFILE",
+            "HOMEPATH",
+            "PATHEXT",
+            "PROFILESFOLDER",
+            "PROGRAMFILES",
+            "PROGRAMFILES(x86)",
+            "SYSTEM",
+            "SYSTEM16",
+            "SYSTEM32",
+            "SYSTEMDRIVE",
+            "SYSTEMPROFILE",
+            "SYSTEMROOT",
+            "TEMP",
+            "TMP",
+            "USERPROFILE",
+            "USERSID",
+            "WINDIR",
+        )
+    }
+
+
 @click.command(
     short_help="Detect and apply a new version",
     context_settings={
@@ -330,6 +365,7 @@ def version(  # noqa: C901
     commit_author = runtime.commit_author
     commit_message = runtime.commit_message
     major_on_zero = runtime.major_on_zero
+    no_verify = runtime.no_git_verify
     build_command = runtime.build_command
     opts = runtime.global_cli_options
     gha_output = VersionGitHubActionsOutput()
@@ -521,6 +557,8 @@ def version(  # noqa: C901
                             "PATH": os.getenv("PATH", ""),
                             "HOME": os.getenv("HOME", None),
                             "VIRTUAL_ENV": os.getenv("VIRTUAL_ENV", None),
+                            # Windows environment variables
+                            **(get_windows_env() if is_windows() else {}),
                             # affects build decisions
                             "CI": os.getenv("CI", None),
                             # Identifies which CI environment
@@ -613,6 +651,7 @@ def version(  # noqa: C901
         )
 
         command += f"git commit -m '{indented_commit_message}'"
+        command += "--no-verify" if no_verify else ""
 
         noop_report(
             indented(
@@ -628,6 +667,7 @@ def version(  # noqa: C901
             repo.git.commit(
                 m=commit_message.format(version=new_version),
                 date=int(commit_date.timestamp()),
+                no_verify=no_verify,
             )
 
     # Run the tagging after potentially creating a new HEAD commit.

semantic_release/cli/config.py

@@ -225,6 +225,7 @@ class RawConfig(BaseModel):
     major_on_zero: bool = True
     allow_zero_version: bool = True
     remote: RemoteConfig = RemoteConfig()
+    no_git_verify: bool = False
     tag_format: str = "v{version}"
     publish: PublishConfig = PublishConfig()
     version_toml: Optional[Tuple[str, ...]] = None
@@ -347,6 +348,7 @@ class RuntimeContext:
     major_on_zero: bool
     allow_zero_version: bool
     prerelease: bool
+    no_git_verify: bool
     assets: List[str]
     commit_author: Actor
     commit_message: str
@@ -596,6 +598,7 @@ class RuntimeContext:
             upload_to_vcs_release=raw.publish.upload_to_vcs_release,
             global_cli_options=global_cli_options,
             masker=masker,
+            no_git_verify=raw.no_git_verify,
         )
         # credential masker
         self.apply_log_masking(self.masker)

semantic_release/hvcs/github.py

@@ -304,7 +304,7 @@ class Github(RemoteHvcsBase):
         """
         Edit a release with updated change notes
         https://docs.github.com/rest/reference/repos#update-a-release
-        :param id: ID of release to update
+        :param release_id: ID of release to update
         :param release_notes: The release notes for this version
         :return: The ID of the release that was edited
         """
@@ -329,8 +329,9 @@ class Github(RemoteHvcsBase):
     ) -> int:
         """
         Post release changelog
-        :param version: The version number
+        :param tag: The version number
         :param release_notes: The release notes for this version
+        :param prerelease: Whether or not this release should be created as a prerelease
         :return: The status of the request
         """
         log.info("Creating release for %s", tag)
@@ -427,8 +428,8 @@ class Github(RemoteHvcsBase):
     def upload_dists(self, tag: str, dist_glob: str) -> int:
         """
         Upload distributions to a release
-        :param version: Version to upload for
-        :param path: Path to the dist directory
+        :param tag: Version to upload for
+        :param dist_glob: Path to the dist directory
         :return: The number of distributions successfully uploaded
         """
         # Find the release corresponding to this version

semantic_release/hvcs/gitlab.py

@@ -9,14 +9,21 @@ from pathlib import PurePosixPath
 from typing import TYPE_CHECKING
 
 import gitlab
+import gitlab.exceptions
+import gitlab.v4
+import gitlab.v4.objects
 from urllib3.util.url import Url, parse_url
 
+from semantic_release.errors import UnexpectedResponse
 from semantic_release.helpers import logged_function
 from semantic_release.hvcs.remote_hvcs_base import RemoteHvcsBase
+from semantic_release.hvcs.util import suppress_not_found
 
 if TYPE_CHECKING:
     from typing import Any, Callable
 
+    from gitlab.v4.objects import Project as GitLabProject
+
 
 log = logging.getLogger(__name__)
 
@@ -45,6 +52,8 @@ class Gitlab(RemoteHvcsBase):
     ) -> None:
         super().__init__(remote_url)
         self.token = token
+        self.project_namespace = f"{self.owner}/{self.repo_name}"
+        self._project: GitLabProject | None = None
 
         domain_url = self._normalize_url(
             hvcs_domain
@@ -63,8 +72,14 @@ class Gitlab(RemoteHvcsBase):
             ).url.rstrip("/")
         )
 
-        self._client = gitlab.Gitlab(self.hvcs_domain.url)
-        self._api_url = parse_url(self._client.url)
+        self._client = gitlab.Gitlab(self.hvcs_domain.url, private_token=self.token)
+        self._api_url = parse_url(self._client.api_url)
+
+    @property
+    def project(self) -> GitLabProject:
+        if self._project is None:
+            self._project = self._client.projects.get(self.project_namespace)
+        return self._project
 
     @lru_cache(maxsize=1)
     def _get_repository_owner_and_name(self) -> tuple[str, str]:
@@ -87,61 +102,146 @@ class Gitlab(RemoteHvcsBase):
         assets: list[str] | None = None,  # noqa: ARG002
     ) -> str:
         """
-        Post release changelog
-        :param tag: Tag to create release for
-        :param release_notes: The release notes for this version
-        :param prerelease: This parameter has no effect
-        :return: The tag of the release
+        Create a release in a remote VCS, adding any release notes and assets to it
+
+        Arguments:
+        ---------
+            tag(str): The tag to create the release for
+            release_notes(str): The changelog description for this version only
+            prerelease(bool): This parameter has no effect in GitLab
+            assets(list[str]): A list of paths to files to upload as assets (TODO: not implemented)
+
+        Returns:
+        -------
+            str: The tag of the release
+
+        Raises:
+        ------
+            GitlabAuthenticationError: If authentication is not correct
+            GitlabCreateError: If the server cannot perform the request
+
         """
-        client = gitlab.Gitlab(self.hvcs_domain.url, private_token=self.token)
-        client.auth()
         log.info("Creating release for %s", tag)
         # ref: https://docs.gitlab.com/ee/api/releases/index.html#create-a-release
-        client.projects.get(self.owner + "/" + self.repo_name).releases.create(
+        self.project.releases.create(
             {
-                "name": "Release " + tag,
+                "name": tag,
                 "tag_name": tag,
+                "tag_message": tag,
                 "description": release_notes,
             }
         )
         log.info("Successfully created release for %s", tag)
         return tag
 
-    # TODO: make str types accepted here
+    @logged_function(log)
+    @suppress_not_found
+    def get_release_by_tag(self, tag: str) -> gitlab.v4.objects.ProjectRelease | None:
+        """
+        Get a release by its tag name
+
+        Arguments:
+        ---------
+            tag(str): The tag name to get the release for
+
+        Returns:
+        -------
+            gitlab.v4.objects.ProjectRelease | None: The release object or None if not found
+
+        Raises:
+        ------
+            gitlab.exceptions.GitlabAuthenticationError: If the user is not authenticated
+
+        """
+        try:
+            return self.project.releases.get(tag)
+        except gitlab.exceptions.GitlabGetError:
+            log.debug("Release %s not found", tag)
+            return None
+        except KeyError as err:
+            raise UnexpectedResponse("JSON response is missing commit.id") from err
+
     @logged_function(log)
     def edit_release_notes(  # type: ignore[override]
         self,
-        release_id: str,
+        release: gitlab.v4.objects.ProjectRelease,
         release_notes: str,
     ) -> str:
-        client = gitlab.Gitlab(self.hvcs_domain.url, private_token=self.token)
-        client.auth()
-        log.info("Updating release %s", release_id)
+        """
+        Update the release notes for a given release
 
-        client.projects.get(self.owner + "/" + self.repo_name).releases.update(
-            release_id,
-            {
-                "description": release_notes,
-            },
+        Arguments:
+        ---------
+            release(gitlab.v4.objects.ProjectRelease): The release object to update
+            release_notes(str): The new release notes
+
+        Returns:
+        -------
+            str: The release id
+
+        Raises:
+        ------
+            GitlabAuthenticationError: If authentication is not correct
+            GitlabUpdateError: If the server cannot perform the request
+
+        """
+        log.info(
+            "Updating release %s [%s]",
+            release.name,
+            release.attributes.get("commit", {}).get("id"),
         )
-        return release_id
+        release.description = release_notes
+        release.save()
+        return str(release.get_id())
 
     @logged_function(log)
     def create_or_update_release(
         self, tag: str, release_notes: str, prerelease: bool = False
     ) -> str:
+        """
+        Create or update a release for the given tag in a remote VCS
+
+        Arguments:
+        ---------
+            tag(str): The tag to create or update the release for
+            release_notes(str): The changelog description for this version only
+            prerelease(bool): This parameter has no effect in GitLab
+
+        Returns:
+        -------
+            str: The release id
+
+        Raises:
+        ------
+            ValueError: If the release could not be created or updated
+            gitlab.exceptions.GitlabAuthenticationError: If the user is not authenticated
+            GitlabUpdateError: If the server cannot perform the request
+
+        """
         try:
             return self.create_release(
                 tag=tag, release_notes=release_notes, prerelease=prerelease
             )
         except gitlab.GitlabCreateError:
             log.info(
-                "Release %s could not be created for project %s/%s",
+                "New release %s could not be created for project %s",
                 tag,
-                self.owner,
-                self.repo_name,
+                self.project_namespace,
+            )
+
+        if (release_obj := self.get_release_by_tag(tag)) is None:
+            raise ValueError(
+                f"release for tag {tag} could not be found, and could not be created"
             )
-            return self.edit_release_notes(release_id=tag, release_notes=release_notes)
+
+        log.debug(
+            "Found existing release commit %s, updating", release_obj.commit.get("id")
+        )
+        # If this errors we let it die
+        return self.edit_release_notes(
+            release=release_obj,
+            release_notes=release_notes,
+        )
 
     def remote_url(self, use_token: bool = True) -> str:
         """Get the remote url including the token for authentication if requested"""
@@ -150,7 +250,7 @@ class Gitlab(RemoteHvcsBase):
 
         return self.create_server_url(
             auth=f"gitlab-ci-token:{self.token}",
-            path=f"{self.owner}/{self.repo_name}.git",
+            path=f"{self.project_namespace}.git",
         )
 
     def compare_url(self, from_rev: str, to_rev: str) -> str: