python-semantic-release 9.4.2__py3-none-any.whl → 9.5.0__py3-none-any.whl

{python_semantic_release-9.4.2.dist-info → python_semantic_release-9.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-semantic-release
-Version: 9.4.2
+Version: 9.5.0
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT
@@ -35,7 +35,7 @@ Requires-Dist: shellingham ~=1.5
 Provides-Extra: dev
 Requires-Dist: pre-commit ~=3.5 ; extra == 'dev'
 Requires-Dist: tox ~=4.11 ; extra == 'dev'
-Requires-Dist: ruff ==0.3.5 ; extra == 'dev'
+Requires-Dist: ruff ==0.4.1 ; 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.4.2.dist-info → python_semantic_release-9.5.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-semantic_release/__init__.py,sha256=PnqssXtNohSJYnHQls9mQ0VheM9Lx9YBzjCAXqFlefs,870
+semantic_release/__init__.py,sha256=OKGFjDLUMtF4yJFzPOCIxLjmnv_T7QJWrmqcCinoIDA,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
@@ -36,7 +36,7 @@ semantic_release/hvcs/__init__.py,sha256=ulesZslSG4Lu8Iz3YzOrPXpdgvgbADq_MV17B-b
 semantic_release/hvcs/_base.py,sha256=qjjlU3rI-sOhIY_FfXsZ9OQGthNYxgzpL4PhlGSXEuA,5232
 semantic_release/hvcs/bitbucket.py,sha256=6vGOcRG7WexxG8SzLcWDIzp7zNpB0ruDLUTQ9GE2jGM,11004
 semantic_release/hvcs/gitea.py,sha256=OTThBTZ93xUP9am7tNIE0UVchhJwG9ASvI6zuiG8oLE,11450
-semantic_release/hvcs/github.py,sha256=qOEGFRYjhGhFfeL7l8adrAUBfi2yd8AUFlARjym383s,16297
+semantic_release/hvcs/github.py,sha256=DI0fK_dhVAzwd6S80zZMMVIAsz-b0zTGca-SMVJIUyE,19965
 semantic_release/hvcs/gitlab.py,sha256=qmowL22DCNOFa7RwmMTmNmno3BS0dyNYT9L36ujgZ8A,7409
 semantic_release/hvcs/token_auth.py,sha256=ZjT56-NIPB4OKIt1qwHCu1TavXnrWFIBl9ARlg56hgU,663
 semantic_release/hvcs/util.py,sha256=PNKXApgL2np9lpnKjAbo77toRgElLPXrbS1q7621waI,2886
@@ -45,10 +45,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.4.2.dist-info/AUTHORS.rst,sha256=XOReVvpymEFUPsS2QPH97jlfJBVrxwS2eu8-jVAe4gk,230
-python_semantic_release-9.4.2.dist-info/LICENSE,sha256=NE85nszX252sdQdu0xgS9qwfYES0k8qS6gW3uO4jRGE,1083
-python_semantic_release-9.4.2.dist-info/METADATA,sha256=9MVGGhT1GY66GdrYc8oVvYaGV2gUS4skpG-DuPd5XIE,5335
-python_semantic_release-9.4.2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-python_semantic_release-9.4.2.dist-info/entry_points.txt,sha256=qojUBx_Ywf4u7KgP6NWlDaBDymZVUGQ7m5wF2duC2F0,95
-python_semantic_release-9.4.2.dist-info/top_level.txt,sha256=qYA24nyg3eP-ti5UW7Vuj2aXVmM0wqVHx4mREdRZNAA,17
-python_semantic_release-9.4.2.dist-info/RECORD,,
+python_semantic_release-9.5.0.dist-info/AUTHORS.rst,sha256=XOReVvpymEFUPsS2QPH97jlfJBVrxwS2eu8-jVAe4gk,230
+python_semantic_release-9.5.0.dist-info/LICENSE,sha256=NE85nszX252sdQdu0xgS9qwfYES0k8qS6gW3uO4jRGE,1083
+python_semantic_release-9.5.0.dist-info/METADATA,sha256=7RR8GcLU8LGCvbkMVyzcxDjom5Fz8xP4lxLMDi8rHLM,5335
+python_semantic_release-9.5.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+python_semantic_release-9.5.0.dist-info/entry_points.txt,sha256=qojUBx_Ywf4u7KgP6NWlDaBDymZVUGQ7m5wF2duC2F0,95
+python_semantic_release-9.5.0.dist-info/top_level.txt,sha256=qYA24nyg3eP-ti5UW7Vuj2aXVmM0wqVHx4mREdRZNAA,17
+python_semantic_release-9.5.0.dist-info/RECORD,,

semantic_release/__init__.py

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

semantic_release/hvcs/github.py

@@ -50,18 +50,28 @@ class Github(HvcsBase):
     GitHub HVCS interface for interacting with GitHub repositories
 
     This class supports the following products:
+
         - GitHub Free, Pro, & Team
         - GitHub Enterprise Cloud
-
-    This class does not support the following products:
         - GitHub Enterprise Server (on-premises installations)
+
+    This interface does its best to detect which product is configured based
+    on the provided domain. If it is the official `github.com`, the default
+    domain, then it is considered as GitHub Enterprise Cloud which uses the
+    subdomain `api.github.com` for api communication.
+
+    If the provided domain is anything else, than it is assumed to be communicating
+    with an on-premise or 3rd-party maintained GitHub instance which matches with
+    the GitHub Enterprise Server product. The on-prem server product uses a
+    path prefix for handling api requests which is configured to be
+    `server.domain/api/v3` based on the documentation in April 2024.
     """
 
-    # TODO: Add support for GitHub Enterprise Server (on-premises installations)
-    #       DEFAULT_ONPREM_API_PATH = "/api/v3"
     DEFAULT_DOMAIN = "github.com"
     DEFAULT_API_SUBDOMAIN_PREFIX = "api"
     DEFAULT_API_DOMAIN = f"{DEFAULT_API_SUBDOMAIN_PREFIX}.{DEFAULT_DOMAIN}"
+    DEFAULT_API_PATH_CLOUD = "/"  # no path prefix!
+    DEFAULT_API_PATH_ONPREM = "/api/v3"
     DEFAULT_ENV_TOKEN_NAME = "GH_TOKEN"  # noqa: S105
 
     def __init__(
@@ -117,10 +127,15 @@ class Github(HvcsBase):
                 # infer from Domain url and prepend the default api subdomain
                 **{
                     **self.hvcs_domain._asdict(),
-                    "host": f"{self.DEFAULT_API_SUBDOMAIN_PREFIX}.{self.hvcs_domain.host}",
-                    "path": "",
+                    "host": self.hvcs_domain.host,
+                    "path": str(
+                        PurePosixPath(
+                            str.lstrip(self.hvcs_domain.path or "", "/") or "/",
+                            self.DEFAULT_API_PATH_ONPREM.lstrip("/"),
+                        )
+                    ),
                 }
-            ).url
+            ).url.rstrip("/")
         )
 
         if api_domain_parts.scheme == "http" and not allow_insecure:
@@ -138,16 +153,66 @@ class Github(HvcsBase):
                 "Only http and https are supported."
             )
 
-        # Strip any auth, query or fragment from the domain
-        self.api_url = parse_url(
+        # As GitHub Enterprise Cloud and GitHub Enterprise Server (on-prem) have different api locations
+        # lets check what we have been given and set the api url accordingly
+        #   NOTE: Github Server (on premise) uses a path prefix '/api/v3' for the api
+        #         while GitHub Enterprise Cloud uses a separate subdomain as the base
+        is_github_cloud = bool(self.hvcs_domain.url == f"https://{self.DEFAULT_DOMAIN}")
+
+        # Calculate out the api url that we expect for GitHub Cloud
+        default_cloud_api_url = parse_url(
             Url(
-                scheme=api_domain_parts.scheme,
-                host=api_domain_parts.host,
-                port=api_domain_parts.port,
-                path=str(PurePosixPath(api_domain_parts.path or "/")),
+                # set api domain and append the default api path
+                **{
+                    **self.hvcs_domain._asdict(),
+                    "host": f"{self.DEFAULT_API_DOMAIN}",
+                    "path": self.DEFAULT_API_PATH_CLOUD,
+                }
             ).url.rstrip("/")
         )
 
+        if (
+            is_github_cloud
+            and hvcs_api_domain
+            and api_domain_parts.url not in default_cloud_api_url.url
+        ):
+            # Api was provied but is not a subset of the expected one, raise an error
+            # we check for a subset because the user may not have provided the full api path
+            # but the correct domain.  If they didn't, then we are erroring out here.
+            raise ValueError(
+                f"Invalid api domain {api_domain_parts.url} for GitHub Enterprise Cloud. "
+                f"Expected {default_cloud_api_url.url}."
+            )
+
+        # Set the api url to the default cloud one if we are on cloud, otherwise
+        # use the verified api domain for a on-prem server
+        self.api_url = (
+            default_cloud_api_url
+            if is_github_cloud
+            else parse_url(
+                # Strip any auth, query or fragment from the domain
+                Url(
+                    scheme=api_domain_parts.scheme,
+                    host=api_domain_parts.host,
+                    port=api_domain_parts.port,
+                    path=str(
+                        PurePosixPath(
+                            # pass any custom server prefix path but ensure we don't
+                            # double up the api path in the case the user provided it
+                            str.replace(
+                                api_domain_parts.path or "",
+                                self.DEFAULT_API_PATH_ONPREM,
+                                "",
+                            ).lstrip("/")
+                            or "/",
+                            # apply the on-prem api path
+                            self.DEFAULT_API_PATH_ONPREM.lstrip("/"),
+                        )
+                    ),
+                ).url.rstrip("/")
+            )
+        )
+
     @lru_cache(maxsize=1)
     def _get_repository_owner_and_name(self) -> tuple[str, str]:
         # Github actions context
@@ -419,7 +484,7 @@ class Github(HvcsBase):
                 lambda x: x[1] is not None,
                 {
                     "auth": auth,
-                    "path": str(PurePosixPath("/", path)),
+                    "path": str(PurePosixPath("/", path.lstrip("/"))),
                     "query": query,
                     "fragment": fragment,
                 }.items(),
@@ -439,7 +504,14 @@ class Github(HvcsBase):
         query: str | None = None,
         fragment: str | None = None,
     ) -> str:
-        return self._derive_url(self.hvcs_domain, path, auth, query, fragment)
+        # Ensure any path prefix is transfered but not doubled up on the derived url
+        return self._derive_url(
+            self.hvcs_domain,
+            path=f"{self.hvcs_domain.path or ''}/{path.lstrip(self.hvcs_domain.path)}",
+            auth=auth,
+            query=query,
+            fragment=fragment,
+        )
 
     def create_api_url(
         self,
@@ -448,4 +520,11 @@ class Github(HvcsBase):
         query: str | None = None,
         fragment: str | None = None,
     ) -> str:
-        return self._derive_url(self.api_url, endpoint, auth, query, fragment)
+        # Ensure any api path prefix is transfered but not doubled up on the derived api url
+        return self._derive_url(
+            self.api_url,
+            path=f"{self.api_url.path or ''}/{endpoint.lstrip(self.api_url.path)}",
+            auth=auth,
+            query=query,
+            fragment=fragment,
+        )