python-semantic-release 9.4.2__tar.gz → 9.5.0__tar.gz

{python_semantic_release-9.4.2/python_semantic_release.egg-info → python_semantic_release-9.5.0}/PKG-INFO

@@ -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
@@ -53,7 +53,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.3.5; extra == "dev"
+Requires-Dist: ruff==0.4.1; extra == "dev"
 Provides-Extra: mypy
 Requires-Dist: mypy==1.9.0; extra == "mypy"
 Requires-Dist: types-requests~=2.31.0; extra == "mypy"

{python_semantic_release-9.4.2 → python_semantic_release-9.5.0}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-semantic-release"
-version = "9.4.2"
+version = "9.5.0"
 description = "Automatic Semantic Versioning for Python projects"
 requires-python = ">=3.8"
 license = { text = "MIT" }
@@ -71,7 +71,7 @@ test = [
 dev = [
   "pre-commit ~= 3.5",
   "tox ~= 4.11",
-  "ruff == 0.3.5"
+  "ruff == 0.4.1"
 ]
 mypy = [
   "mypy == 1.9.0",
@@ -363,70 +363,42 @@ ignore_names = ["change_to_ex_proj_dir", "init_example_project"]
 
 [tool.semantic_release]
 logging_use_named_masks = true
-tag_format = "v{version}"
 commit_parser = "angular"
-commit_author = "semantic-release <semantic-release>"
-commit_message = "{version}\n\nAutomatically generated by python-semantic-release"
 build_command = """
     python -m pip install build~=0.10.0
     python -m build .
 """
 major_on_zero = true
-assets = []
 version_variables = ["semantic_release/__init__.py:__version__"]
 version_toml = ["pyproject.toml:project.version"]
 
-[tool.semantic_release.commit_parser_options]
-allowed_tags = [
-  "build",
-  "chore",
-  "ci",
-  "docs",
-  "feat",
-  "fix",
-  "perf",
-  "style",
-  "refactor",
-  "test",
-]
-minor_tags = ["feat"]
-patch_tags = ["fix", "perf"]
-
 [tool.semantic_release.changelog]
-template_dir = "templates"
-changelog_file = "CHANGELOG.md"
-exclude_commit_patterns = []
-
-[tool.semantic_release.changelog.environment]
-block_start_string = "{%"
-block_end_string = "%}"
-variable_start_string = "{{"
-variable_end_string = "}}"
-comment_start_string = "{#"
-comment_end_string = "#}"
-trim_blocks = false
-lstrip_blocks = false
-newline_sequence = "\n"
-keep_trailing_newline = false
-extensions = []
-autoescape = true
+exclude_commit_patterns = [
+  '''chore(?:\([^)]*?\))?: .+''',
+  '''ci(?:\([^)]*?\))?: .+''',
+  '''refactor(?:\([^)]*?\))?: .+''',
+  '''style(?:\([^)]*?\))?: .+''',
+  '''test(?:\([^)]*?\))?: .+''',
+  '''build\((?!deps\): .+)''',
+  '''Merged? .*''',
+  '''Initial Commit.*''',
+  # Old semantic-release version commits
+  '''^\d+\.\d+\.\d+''',
+]
 
 [tool.semantic_release.branches.main]
 match = "(main|master)"
 prerelease = false
 prerelease_token = "rc"
 
-[tool.semantic_release.branches."8.0.x"]
-match = "8.0.x"
+[tool.semantic_release.branches.alpha]
+match = "^(feat|fix|perf)/.+"
 prerelease = true
-prerelease_token = "rc"
+prerelease_token = "alpha"
 
 [tool.semantic_release.remote]
-name = "origin"
 type = "github"
-ignore_token_for_push = false
 token = { env = "GH_TOKEN" }
 
 [tool.semantic_release.publish]
-dist_glob_patterns = ["dist/*"]
 upload_to_vcs_release = true

{python_semantic_release-9.4.2 → python_semantic_release-9.5.0/python_semantic_release.egg-info}/PKG-INFO

@@ -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
@@ -53,7 +53,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.3.5; extra == "dev"
+Requires-Dist: ruff==0.4.1; extra == "dev"
 Provides-Extra: mypy
 Requires-Dist: mypy==1.9.0; extra == "mypy"
 Requires-Dist: types-requests~=2.31.0; extra == "mypy"

{python_semantic_release-9.4.2 → python_semantic_release-9.5.0}/python_semantic_release.egg-info/requires.txt

@@ -14,7 +14,7 @@ shellingham~=1.5
 [dev]
 pre-commit~=3.5
 tox~=4.11
-ruff==0.3.5
+ruff==0.4.1
 
 [docs]
 Sphinx~=6.0

{python_semantic_release-9.4.2 → python_semantic_release-9.5.0}/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:

{python_semantic_release-9.4.2 → python_semantic_release-9.5.0}/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,
+        )

{python_semantic_release-9.4.2 → python_semantic_release-9.5.0}/tests/command_line/test_changelog.py

@@ -242,9 +242,7 @@ def test_changelog_post_to_release(
     session.mount("https://", mock_adapter)
 
     expected_request_url = "{api_url}/repos/{owner}/{repo_name}/releases".format(
-        # TODO: Fix as this is likely not correct given a custom domain and the
-        # use of GitHub which would be GitHub Enterprise Server which we don't yet support
-        api_url=f"https://api.{EXAMPLE_HVCS_DOMAIN}",  # GitHub API URL
+        api_url=f"https://{EXAMPLE_HVCS_DOMAIN}/api/v3",  # GitHub API URL
         owner=EXAMPLE_REPO_OWNER,
         repo_name=EXAMPLE_REPO_NAME,
     )

{python_semantic_release-9.4.2 → python_semantic_release-9.5.0}/tests/unit/semantic_release/hvcs/test_github.py

@@ -55,12 +55,61 @@ def default_gh_client() -> Generator[Github, None, None]:
     ),
     [
         (
-            # Default values
+            # Default values (GitHub Enterprise Cloud)
             {},
             None,
             None,
-            f"https://{Github.DEFAULT_DOMAIN}",
-            f"https://{Github.DEFAULT_API_DOMAIN}",
+            "https://github.com",
+            "https://api.github.com",
+            False,
+        ),
+        (
+            # Explicitly set default values (GitHub Enterprise Cloud)
+            {},
+            Github.DEFAULT_DOMAIN,
+            Github.DEFAULT_API_DOMAIN,
+            "https://github.com",
+            "https://api.github.com",
+            False,
+        ),
+        (
+            # Pull both locations from environment (GitHub Actions on Cloud)
+            {
+                "GITHUB_SERVER_URL": f"https://{Github.DEFAULT_DOMAIN}",
+                "GITHUB_API_URL": f"https://{Github.DEFAULT_API_DOMAIN}",
+            },
+            None,
+            None,
+            "https://github.com",
+            "https://api.github.com",
+            False,
+        ),
+        (
+            # Explicitly set custom values with full api path
+            {},
+            EXAMPLE_HVCS_DOMAIN,
+            f"{EXAMPLE_HVCS_DOMAIN}{Github.DEFAULT_API_PATH_ONPREM}",
+            f"https://{EXAMPLE_HVCS_DOMAIN}",
+            f"https://{EXAMPLE_HVCS_DOMAIN}{Github.DEFAULT_API_PATH_ONPREM}",
+            False,
+        ),
+        (
+            # Explicitly defined api as subdomain
+            # POSSIBLY WRONG ASSUMPTION of Api path for GitHub Enterprise Server (On Prem)
+            {},
+            f"https://{EXAMPLE_HVCS_DOMAIN}",
+            f"https://api.{EXAMPLE_HVCS_DOMAIN}",
+            f"https://{EXAMPLE_HVCS_DOMAIN}",
+            f"https://api.{EXAMPLE_HVCS_DOMAIN}{Github.DEFAULT_API_PATH_ONPREM}",
+            False,
+        ),
+        (
+            # Custom domain with path prefix
+            {},
+            "special.custom.server/vcs",
+            None,
+            "https://special.custom.server/vcs",
+            "https://special.custom.server/vcs/api/v3",
             False,
         ),
         (
@@ -69,19 +118,19 @@ def default_gh_client() -> Generator[Github, None, None]:
             None,
             None,
             "https://special.custom.server",
-            "https://api.special.custom.server",
+            "https://special.custom.server/api/v3",
             False,
         ),
         (
-            # Pull both locations from environment
+            # Pull both locations from environment (On-prem Actions Env)
             {
                 "GITHUB_SERVER_URL": "https://special.custom.server/",
-                "GITHUB_API_URL": "https://api2.special.custom.server/",
+                "GITHUB_API_URL": "https://special.custom.server/api/v3",
             },
             None,
             None,
             "https://special.custom.server",
-            "https://api2.special.custom.server",
+            "https://special.custom.server/api/v3",
             False,
         ),
         (
@@ -91,25 +140,25 @@ def default_gh_client() -> Generator[Github, None, None]:
             f"https://{EXAMPLE_HVCS_DOMAIN}",
             None,
             f"https://{EXAMPLE_HVCS_DOMAIN}",
-            f"https://api.{EXAMPLE_HVCS_DOMAIN}",
+            f"https://{EXAMPLE_HVCS_DOMAIN}/api/v3",
             False,
         ),
         (
             # Ignore environment & use provided parameter value (ie from user config)
             {"GITHUB_API_URL": "https://api.special.custom.server/"},
             f"https://{EXAMPLE_HVCS_DOMAIN}",
-            f"https://api.{EXAMPLE_HVCS_DOMAIN}",
+            f"https://{EXAMPLE_HVCS_DOMAIN}/api/v3",
             f"https://{EXAMPLE_HVCS_DOMAIN}",
-            f"https://api.{EXAMPLE_HVCS_DOMAIN}",
+            f"https://{EXAMPLE_HVCS_DOMAIN}/api/v3",
             False,
         ),
         (
             # Allow insecure http connections explicitly
             {},
             f"http://{EXAMPLE_HVCS_DOMAIN}",
-            f"http://api.{EXAMPLE_HVCS_DOMAIN}",
+            f"http://{EXAMPLE_HVCS_DOMAIN}/api/v3",
             f"http://{EXAMPLE_HVCS_DOMAIN}",
-            f"http://api.{EXAMPLE_HVCS_DOMAIN}",
+            f"http://{EXAMPLE_HVCS_DOMAIN}/api/v3",
             True,
         ),
         (
@@ -118,16 +167,16 @@ def default_gh_client() -> Generator[Github, None, None]:
             f"http://{EXAMPLE_HVCS_DOMAIN}",
             None,
             f"http://{EXAMPLE_HVCS_DOMAIN}",
-            f"http://api.{EXAMPLE_HVCS_DOMAIN}",
+            f"http://{EXAMPLE_HVCS_DOMAIN}/api/v3",
             True,
         ),
         (
             # Infer insecure connection from user configuration
             {},
             EXAMPLE_HVCS_DOMAIN,
-            f"api.{EXAMPLE_HVCS_DOMAIN}",
+            EXAMPLE_HVCS_DOMAIN,
             f"http://{EXAMPLE_HVCS_DOMAIN}",
-            f"http://api.{EXAMPLE_HVCS_DOMAIN}",
+            f"http://{EXAMPLE_HVCS_DOMAIN}/api/v3",
             True,
         ),
         (
@@ -136,7 +185,7 @@ def default_gh_client() -> Generator[Github, None, None]:
             EXAMPLE_HVCS_DOMAIN,
             None,
             f"http://{EXAMPLE_HVCS_DOMAIN}",
-            f"http://api.{EXAMPLE_HVCS_DOMAIN}",
+            f"http://{EXAMPLE_HVCS_DOMAIN}/api/v3",
             True,
         ),
     ],