python-semantic-release 9.7.3__tar.gz → 9.8.1__tar.gz

{python_semantic_release-9.7.3/python_semantic_release.egg-info → python_semantic_release-9.8.1}/PKG-INFO

@@ -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
@@ -55,7 +55,7 @@ Requires-Dist: types-pytest-lazy-fixture~=0.6.3; extra == "test"
 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: mypy
 Requires-Dist: mypy==1.10.0; extra == "mypy"
 Requires-Dist: types-requests~=2.31.0; extra == "mypy"

{python_semantic_release-9.7.3 → python_semantic_release-9.8.1}/docs/configuration.rst

@@ -207,6 +207,33 @@ PSR_DOCKER_GITHUB_ACTION  Pass-through ``true`` if exists in process env, unset
 VIRTUAL_ENV               Pass-through ``VIRTUAL_ENV`` if exists in process env, unset otherwise
 ========================  ======================================================================
 
+In addition, on windows systems these environment variables are passed:
+========================  ======================================================================
+Variable Name             Description
+========================  ======================================================================
+ALLUSERSAPPDATA           Pass-through ``ALLUSERAPPDATA`` if exists in process env, unset otherwise
+ALLUSERSPROFILE           Pass-through ``ALLUSERSPPPROFILE`` if exists in process env, unset otherwise
+APPDATA                   Pass-through ``APPDATA`` if exists in process env, unset otherwise
+COMMONPROGRAMFILES        Pass-through ``COMMONPROGRAMFILES`` if exists in process env, unset otherwise
+COMMONPROGRAMFILES(x86)   Pass-through ``COMMONPROGRAMFILES(x86)`` if exists in process env, unset otherwise
+DEFAULTUSERPROFILE        Pass-through ``DEFAULTUSERPROFILE`` if exists in process env, unset otherwise
+HOMEPATH                  Pass-through ``HOMEPATH`` if exists in process env, unset otherwise
+PATHEXT                   Pass-through ``PATHEXT`` if exists in process env, unset otherwise
+PROFILESFOLDER            Pass-through ``PROFILESFOLDER`` if exists in process env, unset otherwise
+PROGRAMFILES              Pass-through ``PROGRAMFILES`` if exists in process env, unset otherwise
+PROGRAMFILES(x86)         Pass-through ``PROGRAMFILES(x86)`` if exists in process env, unset otherwise
+SYSTEM                    Pass-through ``SYSTEM`` if exists in process env, unset otherwise
+SYSTEM16                  Pass-through ``SYSTEM16`` if exists in process env, unset otherwise
+SYSTEM32                  Pass-through ``SYSTEM32`` if exists in process env, unset otherwise
+SYSTEMDRIVE               Pass-through ``SYSTEMDRIVE`` if exists in process env, unset otherwise
+SYSTEMROOT                Pass-through ``SYSTEMROOT`` if exists in process env, unset otherwise
+TEMP                      Pass-through ``TEMP`` if exists in process env, unset otherwise
+TMP                       Pass-through ``TMP`` if exists in process env, unset otherwise
+USERPROFILE               Pass-through ``USERPROFILE`` if exists in process env, unset otherwise
+USERSID                   Pass-through ``USERSID`` if exists in process env, unset otherwise
+WINDIR                    Pass-through ``WINDIR`` if exists in process env, unset otherwise
+========================  ======================================================================
+
 **Default:** ``None`` (not specified)
 
 ----
@@ -702,6 +729,24 @@ When :ref:`config-allow_zero_version` is set to ``false``, this setting is ignor
 
 ----
 
+.. _config-no_git_verify:
+
+``no_git_verify``
+"""""""""""""""""
+
+**Type:** ``bool``
+
+This flag is passed along to ``git`` upon performing a ``git commit`` during :ref:`cmd-version`.
+
+When true, it will bypass any git hooks that are set for the repository when Python Semantic
+Release makes a version commit.  When false, the commit is performed as normal. This option
+has no effect when there are not any git hooks configured nor when the ``--no-commit`` option
+is passed.
+
+**Default:** ``false``
+
+----
+
 .. _config-publish:
 
 ``publish``

{python_semantic_release-9.7.3 → python_semantic_release-9.8.1}/docs/migrating_from_v7.rst

@@ -74,7 +74,7 @@ GitHub Action:
    on:
      push:
        branches:
-         - master
+         - main
 
    jobs:
      release:
@@ -91,18 +91,18 @@ GitHub Action:
        # This action uses Python Semantic Release v8
        - name: Python Semantic Release
          id: release
-         uses: python-semantic-release/python-semantic-release@v8.0.0
+         uses: python-semantic-release/python-semantic-release@v8.7.0
          with:
            github_token: ${{ secrets.GITHUB_TOKEN }}
 
        - name: Publish package distributions to PyPI
-         uses: pypa/gh-action-pypi-publish@release/v1
+         uses: pypa/gh-action-pypi-publish@v1
          # NOTE: DO NOT wrap the conditional in ${{ }} as it will always evaluate to true.
          # See https://github.com/actions/runner/issues/1173
          if: steps.release.outputs.released == 'true'
 
        - name: Publish package distributions to GitHub Releases
-         uses: python-semantic-release/upload-to-gh-release@main
+         uses: python-semantic-release/upload-to-gh-release@v8.7.0
          if: steps.release.outputs.released == 'true'
          with:
            github_token: ${{ secrets.GITHUB_TOKEN }}

{python_semantic_release-9.7.3 → python_semantic_release-9.8.1}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-semantic-release"
-version = "9.7.3"
+version = "9.8.1"
 description = "Automatic Semantic Versioning for Python projects"
 requires-python = ">=3.8"
 license = { text = "MIT" }
@@ -74,7 +74,7 @@ test = [
 dev = [
   "pre-commit ~= 3.5",
   "tox ~= 4.11",
-  "ruff == 0.4.3"
+  "ruff == 0.4.4"
 ]
 mypy = [
   "mypy == 1.10.0",

{python_semantic_release-9.7.3 → python_semantic_release-9.8.1/python_semantic_release.egg-info}/PKG-INFO

@@ -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
@@ -55,7 +55,7 @@ Requires-Dist: types-pytest-lazy-fixture~=0.6.3; extra == "test"
 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: mypy
 Requires-Dist: mypy==1.10.0; extra == "mypy"
 Requires-Dist: types-requests~=2.31.0; extra == "mypy"

{python_semantic_release-9.7.3 → python_semantic_release-9.8.1}/python_semantic_release.egg-info/requires.txt

@@ -17,7 +17,7 @@ build~=1.2
 [dev]
 pre-commit~=3.5
 tox~=4.11
-ruff==0.4.3
+ruff==0.4.4
 
 [docs]
 Sphinx~=6.0

{python_semantic_release-9.7.3 → python_semantic_release-9.8.1}/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:

{python_semantic_release-9.7.3 → python_semantic_release-9.8.1}/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.

{python_semantic_release-9.7.3 → python_semantic_release-9.8.1}/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)

{python_semantic_release-9.7.3 → python_semantic_release-9.8.1}/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

{python_semantic_release-9.7.3 → python_semantic_release-9.8.1}/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: