python-semantic-release 9.21.0__tar.gz → 9.21.1__tar.gz

{python_semantic_release-9.21.0/src/python_semantic_release.egg-info → python_semantic_release-9.21.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: python-semantic-release
-Version: 9.21.0
+Version: 9.21.1
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT
@@ -26,12 +26,12 @@ Requires-Dist: click-option-group~=0.5
 Requires-Dist: gitpython~=3.0
 Requires-Dist: requests~=2.25
 Requires-Dist: jinja2~=3.1
-Requires-Dist: python-gitlab~=4.0
+Requires-Dist: python-gitlab<6.0.0,>=4.0.0
 Requires-Dist: tomlkit~=0.11
 Requires-Dist: dotty-dict~=1.3
 Requires-Dist: importlib-resources~=6.0
 Requires-Dist: pydantic~=2.0
-Requires-Dist: rich~=13.0
+Requires-Dist: rich~=14.0
 Requires-Dist: shellingham~=1.5
 Requires-Dist: Deprecated~=1.2
 Provides-Extra: build
@@ -49,7 +49,7 @@ Requires-Dist: freezegun~=1.5; extra == "test"
 Requires-Dist: pyyaml~=6.0; extra == "test"
 Requires-Dist: pytest~=8.3; extra == "test"
 Requires-Dist: pytest-clarity~=1.0; extra == "test"
-Requires-Dist: pytest-cov~=5.0; extra == "test"
+Requires-Dist: pytest-cov<7.0.0,>=5.0.0; extra == "test"
 Requires-Dist: pytest-env~=1.0; extra == "test"
 Requires-Dist: pytest-lazy-fixtures~=1.1.1; extra == "test"
 Requires-Dist: pytest-mock~=3.0; extra == "test"
@@ -67,6 +67,7 @@ Requires-Dist: mypy==1.15.0; extra == "mypy"
 Requires-Dist: types-Deprecated~=1.2; extra == "mypy"
 Requires-Dist: types-requests~=2.32.0; extra == "mypy"
 Requires-Dist: types-pyyaml~=6.0; extra == "mypy"
+Dynamic: license-file
 
 Python Semantic Release
 ***********************

{python_semantic_release-9.21.0 → python_semantic_release-9.21.1}/docs/automatic-releases/github-actions.rst

@@ -337,7 +337,7 @@ before the :ref:`version <cmd-version>` subcommand.
 
   .. code:: yaml
 
-    - uses: python-semantic-release/python-semantic-release@v9.20.0
+    - uses: python-semantic-release/python-semantic-release@v9.21.0
       with:
         root_options: "-vv --noop"
 
@@ -576,7 +576,7 @@ before the :ref:`publish <cmd-publish>` subcommand.
 
   .. code:: yaml
 
-    - uses: python-semantic-release/publish-action@v9.20.0
+    - uses: python-semantic-release/publish-action@v9.21.0
       with:
         root_options: "-vv --noop"
 
@@ -728,23 +728,23 @@ 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@v9.20.0
+            uses: python-semantic-release/python-semantic-release@v9.21.0
             with:
               github_token: ${{ secrets.GITHUB_TOKEN }}
               git_committer_name: "github-actions"
               git_committer_email: "actions@users.noreply.github.com"
 
-          - name: Publish | Upload package to PyPI
-            uses: pypa/gh-action-pypi-publish@v1
-            if: steps.release.outputs.released == 'true'
-
           - name: Publish | Upload to GitHub Release Assets
-            uses: python-semantic-release/publish-action@v9.20.0
+            uses: python-semantic-release/publish-action@v9.21.0
             if: steps.release.outputs.released == 'true'
             with:
               github_token: ${{ secrets.GITHUB_TOKEN }}
               tag: ${{ steps.release.outputs.tag }}
 
+          - name: Publish | Upload package to PyPI
+            uses: pypa/gh-action-pypi-publish@SHA1_HASH  # vX.X.X
+            if: steps.release.outputs.released == 'true'
+
 .. important::
   The `concurrency`_ directive is used on the job to prevent race conditions of more than
   one release job in the case if there are multiple pushes to ``main`` in a short period
@@ -794,7 +794,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@v9.20.0
+    uses: python-semantic-release/python-semantic-release@v9.21.0
     with:
       github_token: ${{ secrets.GITHUB_TOKEN }}
       force: patch
@@ -816,19 +816,84 @@ For multiple packages, you would need to run the action multiple times, to relea
 each project. The following example demonstrates how to release two projects in
 a monorepo.
 
+Remember that for each release of each submodule you will then need to handle publishing
+each package separately as well. This is dependent on the result of your build commands.
+In the example below, we assume a simple ``build`` module command to build a ``sdist``
+and wheel artifacts into the submodule's ``dist`` directory.
+
 The ``directory`` input directive is also available for the Python Semantic Release
 Publish Action.
 
 .. code:: yaml
 
-   - name: Release Project 1
-     uses: python-semantic-release/python-semantic-release@v9.20.0
-     with:
-       directory: ./project1
-       github_token: ${{ secrets.GITHUB_TOKEN }}
-
-   - name: Release Project 2
-     uses: python-semantic-release/python-semantic-release@v9.20.0
-     with:
-       directory: ./project2
-       github_token: ${{ secrets.GITHUB_TOKEN }}
+  jobs:
+
+    release:
+
+      env:
+        SUBMODULE_1_DIR: project1
+        SUBMODULE_2_DIR: project2
+
+      steps:
+
+        # ------------------------------------------------------------------- #
+        # Note the use of different IDs to distinguish which submodule was    #
+        # identified to be released. The subsequent actions then reference    #
+        # their specific release ID to determine if a release occurred.       #
+        # ------------------------------------------------------------------- #
+
+        - name: Release submodule 1
+          id: release-submod-1
+          uses: python-semantic-release/python-semantic-release@v9.21.0
+          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@v9.21.0
+          with:
+            directory: ${{ env.SUBMODULE_2_DIR }}
+            github_token: ${{ secrets.GITHUB_TOKEN }}
+
+        # ------------------------------------------------------------------- #
+        # For each submodule, you will have to publish the package separately #
+        # and only attempt to publish if the release for that submodule was   #
+        # deemed a release (and the release was successful).                  #
+        # ------------------------------------------------------------------- #
+
+        - name: Publish | Upload package 1 to GitHub Release Assets
+          uses: python-semantic-release/publish-action@v9.21.0
+          if: steps.release-submod-1.outputs.released == 'true'
+          with:
+            directory: ${{ env.SUBMODULE_1_DIR }}
+            github_token: ${{ secrets.GITHUB_TOKEN }}
+            tag: ${{ steps.release-submod-1.outputs.tag }}
+
+        - name: Publish | Upload package 2 to GitHub Release Assets
+          uses: python-semantic-release/publish-action@v9.21.0
+          if: steps.release-submod-2.outputs.released == 'true'
+          with:
+            directory: ${{ env.SUBMODULE_2_DIR }}
+            github_token: ${{ secrets.GITHUB_TOKEN }}
+            tag: ${{ steps.release-submod-2.outputs.tag }}
+
+        # ------------------------------------------------------------------- #
+        # Python Semantic Release is not responsible for publishing your      #
+        # python artifacts to PyPI. Use the official PyPA publish action      #
+        # instead. The following steps are an example but is not guaranteed   #
+        # to work as the action is not maintained by the                      #
+        # python-semantic-release team.                                       #
+        # ------------------------------------------------------------------- #
+
+        - name: Publish | Upload package 1 to PyPI
+          uses: pypa/gh-action-pypi-publish@SHA1_HASH  # vX.X.X
+          if: steps.release-submod-1.outputs.released == 'true'
+          with:
+            packages-dir: ${{ format('{}/dist', env.SUBMODULE_1_DIR) }}
+
+        - name: Publish | Upload package 2 to PyPI
+          uses: pypa/gh-action-pypi-publish@SHA1_HASH  # vX.X.X
+          if: steps.release-submod-2.outputs.released == 'true'
+          with:
+            packages-dir: ${{ format('{}/dist', env.SUBMODULE_2_DIR) }}

{python_semantic_release-9.21.0 → python_semantic_release-9.21.1}/pyproject.toml

@@ -1,12 +1,12 @@
 # Ref: https://packaging.python.org/en/latest/specifications/declaring-project-metadata/
 # and https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html
 [build-system]
-requires = ["setuptools ~= 75.3.0", "wheel ~= 0.42"]
+requires = ["setuptools >= 75.3.0, < 81.0.0", "wheel ~= 0.42"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-semantic-release"
-version = "9.21.0"
+version = "9.21.1"
 description = "Automatic Semantic Versioning for Python projects"
 requires-python = ">=3.8"
 license = { text = "MIT" }
@@ -28,12 +28,12 @@ dependencies = [
   "gitpython ~= 3.0",
   "requests ~= 2.25",
   "jinja2 ~= 3.1",
-  "python-gitlab ~= 4.0",
+  "python-gitlab >= 4.0.0, < 6.0.0",
   "tomlkit ~= 0.11",
   "dotty-dict ~= 1.3",
   "importlib-resources ~= 6.0",
   "pydantic ~= 2.0",
-  "rich ~= 13.0",
+  "rich ~= 14.0",
   "shellingham ~= 1.5",
   "Deprecated ~= 1.2",  # Backport of deprecated decorator for python 3.8
 ]
@@ -68,7 +68,7 @@ test = [
   "pyyaml ~= 6.0",
   "pytest ~= 8.3",
   "pytest-clarity ~= 1.0",
-  "pytest-cov ~= 5.0",
+  "pytest-cov >= 5.0.0, < 7.0.0",
   "pytest-env ~= 1.0",
   "pytest-lazy-fixtures ~= 1.1.1",
   "pytest-mock ~= 3.0",
@@ -412,7 +412,6 @@ build_command = """
     python -m build .
 """
 major_on_zero = true
-version_variables = ["src/semantic_release/__init__.py:__version__"]
 version_toml = ["pyproject.toml:project.version"]
 
 [tool.semantic_release.changelog]

{python_semantic_release-9.21.0 → python_semantic_release-9.21.1/src/python_semantic_release.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: python-semantic-release
-Version: 9.21.0
+Version: 9.21.1
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT
@@ -26,12 +26,12 @@ Requires-Dist: click-option-group~=0.5
 Requires-Dist: gitpython~=3.0
 Requires-Dist: requests~=2.25
 Requires-Dist: jinja2~=3.1
-Requires-Dist: python-gitlab~=4.0
+Requires-Dist: python-gitlab<6.0.0,>=4.0.0
 Requires-Dist: tomlkit~=0.11
 Requires-Dist: dotty-dict~=1.3
 Requires-Dist: importlib-resources~=6.0
 Requires-Dist: pydantic~=2.0
-Requires-Dist: rich~=13.0
+Requires-Dist: rich~=14.0
 Requires-Dist: shellingham~=1.5
 Requires-Dist: Deprecated~=1.2
 Provides-Extra: build
@@ -49,7 +49,7 @@ Requires-Dist: freezegun~=1.5; extra == "test"
 Requires-Dist: pyyaml~=6.0; extra == "test"
 Requires-Dist: pytest~=8.3; extra == "test"
 Requires-Dist: pytest-clarity~=1.0; extra == "test"
-Requires-Dist: pytest-cov~=5.0; extra == "test"
+Requires-Dist: pytest-cov<7.0.0,>=5.0.0; extra == "test"
 Requires-Dist: pytest-env~=1.0; extra == "test"
 Requires-Dist: pytest-lazy-fixtures~=1.1.1; extra == "test"
 Requires-Dist: pytest-mock~=3.0; extra == "test"
@@ -67,6 +67,7 @@ Requires-Dist: mypy==1.15.0; extra == "mypy"
 Requires-Dist: types-Deprecated~=1.2; extra == "mypy"
 Requires-Dist: types-requests~=2.32.0; extra == "mypy"
 Requires-Dist: types-pyyaml~=6.0; extra == "mypy"
+Dynamic: license-file
 
 Python Semantic Release
 ***********************

{python_semantic_release-9.21.0 → python_semantic_release-9.21.1}/src/python_semantic_release.egg-info/requires.txt

@@ -3,12 +3,12 @@ click-option-group~=0.5
 gitpython~=3.0
 requests~=2.25
 jinja2~=3.1
-python-gitlab~=4.0
+python-gitlab<6.0.0,>=4.0.0
 tomlkit~=0.11
 dotty-dict~=1.3
 importlib-resources~=6.0
 pydantic~=2.0
-rich~=13.0
+rich~=14.0
 shellingham~=1.5
 Deprecated~=1.2
 
@@ -40,7 +40,7 @@ freezegun~=1.5
 pyyaml~=6.0
 pytest~=8.3
 pytest-clarity~=1.0
-pytest-cov~=5.0
+pytest-cov<7.0.0,>=5.0.0
 pytest-env~=1.0
 pytest-lazy-fixtures~=1.1.1
 pytest-mock~=3.0

{python_semantic_release-9.21.0 → python_semantic_release-9.21.1}/src/semantic_release/__init__.py

@@ -2,6 +2,8 @@
 
 from __future__ import annotations
 
+import importlib.metadata
+
 from semantic_release.commit_parser import (
     CommitParser,
     ParsedCommit,
@@ -24,7 +26,7 @@ from semantic_release.version import (
     tags_and_versions,
 )
 
-__version__ = "9.21.0"
+__version__ = importlib.metadata.version(f"python_{__package__}".replace("_", "-"))
 
 __all__ = [
     "CommitParser",

{python_semantic_release-9.21.0 → python_semantic_release-9.21.1}/src/semantic_release/hvcs/remote_hvcs_base.py

@@ -95,10 +95,15 @@ class RemoteHvcsBase(HvcsBase, metaclass=ABCMeta):
         query: str | None = None,
         fragment: str | None = None,
     ) -> str:
-        # Ensure any path prefix is transfered but not doubled up on the derived url
+        # Ensure any path prefix is transferred but not doubled up on the derived url
+        normalized_path = (
+            f"{self.hvcs_domain.path}/{path}"
+            if self.hvcs_domain.path and not path.startswith(self.hvcs_domain.path)
+            else path
+        )
         return self._derive_url(
             self.hvcs_domain,
-            path=f"{self.hvcs_domain.path or ''}/{path.lstrip(self.hvcs_domain.path)}",
+            path=normalized_path,
             auth=auth,
             query=query,
             fragment=fragment,
@@ -123,10 +128,15 @@ class RemoteHvcsBase(HvcsBase, metaclass=ABCMeta):
         query: str | None = None,
         fragment: str | None = None,
     ) -> str:
-        # Ensure any api path prefix is transfered but not doubled up on the derived api url
+        # Ensure any api path prefix is transferred but not doubled up on the derived api url
+        normalized_endpoint = (
+            f"{self.api_url.path}/{endpoint}"
+            if self.api_url.path and not endpoint.startswith(self.api_url.path)
+            else endpoint
+        )
         return self._derive_url(
             self.api_url,
-            path=f"{self.api_url.path or ''}/{endpoint.lstrip(self.api_url.path)}",
+            path=normalized_endpoint,
             auth=auth,
             query=query,
             fragment=fragment,

{python_semantic_release-9.21.0 → python_semantic_release-9.21.1}/tests/unit/semantic_release/hvcs/test_bitbucket.py

@@ -301,6 +301,29 @@ def test_commit_hash_url(default_bitbucket_client: Bitbucket):
     assert expected_url == default_bitbucket_client.commit_hash_url(sha)
 
 
+def test_commit_hash_url_w_custom_server():
+    """
+    Test the commit hash URL generation for a self-hosted Bitbucket server with prefix.
+
+    ref: https://github.com/python-semantic-release/python-semantic-release/issues/1204
+    """
+    sha = "244f7e11bcb1e1ce097db61594056bc2a32189a0"
+    expected_url = "{server}/{owner}/{repo}/commits/{sha}".format(
+        server=f"https://{EXAMPLE_HVCS_DOMAIN}/projects/demo-foo",
+        owner="foo",
+        repo=EXAMPLE_REPO_NAME,
+        sha=sha,
+    )
+
+    with mock.patch.dict(os.environ, {}, clear=True):
+        actual_url = Bitbucket(
+            remote_url=f"https://{EXAMPLE_HVCS_DOMAIN}/projects/demo-foo/foo/{EXAMPLE_REPO_NAME}.git",
+            hvcs_domain=f"https://{EXAMPLE_HVCS_DOMAIN}/projects/demo-foo",
+        ).commit_hash_url(sha)
+
+    assert expected_url == actual_url
+
+
 @pytest.mark.parametrize("pr_number", (666, "666", "#666"))
 def test_pull_request_url(default_bitbucket_client: Bitbucket, pr_number: int | str):
     expected_url = "{server}/{owner}/{repo}/pull-requests/{pr_number}".format(

{python_semantic_release-9.21.0 → python_semantic_release-9.21.1}/tests/unit/semantic_release/hvcs/test_gitea.py

@@ -203,6 +203,29 @@ def test_commit_hash_url(default_gitea_client: Gitea):
     assert expected_url == default_gitea_client.commit_hash_url(sha)
 
 
+def test_commit_hash_url_w_custom_server():
+    """
+    Test the commit hash URL generation for a self-hosted Bitbucket server with prefix.
+
+    ref: https://github.com/python-semantic-release/python-semantic-release/issues/1204
+    """
+    sha = "244f7e11bcb1e1ce097db61594056bc2a32189a0"
+    expected_url = "{server}/{owner}/{repo}/commit/{sha}".format(
+        server=f"https://{EXAMPLE_HVCS_DOMAIN}/projects/demo-foo",
+        owner="foo",
+        repo=EXAMPLE_REPO_NAME,
+        sha=sha,
+    )
+
+    with mock.patch.dict(os.environ, {}, clear=True):
+        actual_url = Gitea(
+            remote_url=f"https://{EXAMPLE_HVCS_DOMAIN}/projects/demo-foo/foo/{EXAMPLE_REPO_NAME}.git",
+            hvcs_domain=f"https://{EXAMPLE_HVCS_DOMAIN}/projects/demo-foo",
+        ).commit_hash_url(sha)
+
+    assert expected_url == actual_url
+
+
 @pytest.mark.parametrize("issue_number", (666, "666", "#666"))
 def test_issue_url(default_gitea_client: Gitea, issue_number: int | str):
     expected_url = "{server}/{owner}/{repo}/issues/{issue_number}".format(

{python_semantic_release-9.21.0 → python_semantic_release-9.21.1}/tests/unit/semantic_release/hvcs/test_github.py

@@ -375,6 +375,29 @@ def test_commit_hash_url(default_gh_client: Github):
     assert expected_url == default_gh_client.commit_hash_url(sha)
 
 
+def test_commit_hash_url_w_custom_server():
+    """
+    Test the commit hash URL generation for a self-hosted Bitbucket server with prefix.
+
+    ref: https://github.com/python-semantic-release/python-semantic-release/issues/1204
+    """
+    sha = "244f7e11bcb1e1ce097db61594056bc2a32189a0"
+    expected_url = "{server}/{owner}/{repo}/commit/{sha}".format(
+        server=f"https://{EXAMPLE_HVCS_DOMAIN}/projects/demo-foo",
+        owner="foo",
+        repo=EXAMPLE_REPO_NAME,
+        sha=sha,
+    )
+
+    with mock.patch.dict(os.environ, {}, clear=True):
+        actual_url = Github(
+            remote_url=f"https://{EXAMPLE_HVCS_DOMAIN}/projects/demo-foo/foo/{EXAMPLE_REPO_NAME}.git",
+            hvcs_domain=f"https://{EXAMPLE_HVCS_DOMAIN}/projects/demo-foo",
+        ).commit_hash_url(sha)
+
+    assert expected_url == actual_url
+
+
 @pytest.mark.parametrize("issue_number", (666, "666", "#666"))
 def test_issue_url(default_gh_client: Github, issue_number: str | int):
     expected_url = "{server}/{owner}/{repo}/issues/{issue_num}".format(

{python_semantic_release-9.21.0 → python_semantic_release-9.21.1}/tests/unit/semantic_release/hvcs/test_gitlab.py

@@ -260,6 +260,29 @@ def test_commit_hash_url(default_gl_client: Gitlab):
     assert expected_url == default_gl_client.commit_hash_url(REF)
 
 
+def test_commit_hash_url_w_custom_server():
+    """
+    Test the commit hash URL generation for a self-hosted Bitbucket server with prefix.
+
+    ref: https://github.com/python-semantic-release/python-semantic-release/issues/1204
+    """
+    sha = "244f7e11bcb1e1ce097db61594056bc2a32189a0"
+    expected_url = "{server}/{owner}/{repo}/-/commit/{sha}".format(
+        server=f"https://{EXAMPLE_HVCS_DOMAIN}/projects/demo-foo",
+        owner="foo",
+        repo=EXAMPLE_REPO_NAME,
+        sha=sha,
+    )
+
+    with mock.patch.dict(os.environ, {}, clear=True):
+        actual_url = Gitlab(
+            remote_url=f"https://{EXAMPLE_HVCS_DOMAIN}/projects/demo-foo/foo/{EXAMPLE_REPO_NAME}.git",
+            hvcs_domain=f"https://{EXAMPLE_HVCS_DOMAIN}/projects/demo-foo",
+        ).commit_hash_url(sha)
+
+    assert expected_url == actual_url
+
+
 @pytest.mark.parametrize("issue_number", (666, "666", "#666"))
 def test_issue_url(default_gl_client: Gitlab, issue_number: int | str):
     expected_url = "{server}/{owner}/{repo}/-/issues/{issue_num}".format(