python-semantic-release 10.1.0__tar.gz → 10.2.0__tar.gz

{python_semantic_release-10.1.0 → python_semantic_release-10.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-semantic-release
-Version: 10.1.0
+Version: 10.2.0
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT
@@ -62,7 +62,7 @@ Requires-Dist: pre-commit~=3.5; extra == "dev"
 Requires-Dist: tox~=4.11; extra == "dev"
 Requires-Dist: ruff==0.6.1; extra == "dev"
 Provides-Extra: mypy
-Requires-Dist: mypy==1.16.0; extra == "mypy"
+Requires-Dist: mypy==1.16.1; 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"

{python_semantic_release-10.1.0 → python_semantic_release-10.2.0}/docs/configuration/automatic-releases/github-actions.rst

@@ -873,14 +873,14 @@ 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@v10.1.0
+            uses: python-semantic-release/python-semantic-release@v10.2.0
             with:
               github_token: ${{ secrets.GITHUB_TOKEN }}
               git_committer_name: "github-actions"
               git_committer_email: "actions@users.noreply.github.com"
 
           - name: Publish | Upload to GitHub Release Assets
-            uses: python-semantic-release/publish-action@v10.1.0
+            uses: python-semantic-release/publish-action@v10.2.0
             if: steps.release.outputs.released == 'true'
             with:
               github_token: ${{ secrets.GITHUB_TOKEN }}
@@ -979,7 +979,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@v10.1.0
+    uses: python-semantic-release/python-semantic-release@v10.2.0
     with:
       github_token: ${{ secrets.GITHUB_TOKEN }}
       force: patch
@@ -1038,14 +1038,14 @@ Publish Action.
 
         - name: Release submodule 1
           id: release-submod-1
-          uses: python-semantic-release/python-semantic-release@v10.1.0
+          uses: python-semantic-release/python-semantic-release@v10.2.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@v10.1.0
+          uses: python-semantic-release/python-semantic-release@v10.2.0
           with:
             directory: ${{ env.SUBMODULE_2_DIR }}
             github_token: ${{ secrets.GITHUB_TOKEN }}
@@ -1057,7 +1057,7 @@ Publish Action.
         # ------------------------------------------------------------------- #
 
         - name: Publish | Upload package 1 to GitHub Release Assets
-          uses: python-semantic-release/publish-action@v10.1.0
+          uses: python-semantic-release/publish-action@v10.2.0
           if: steps.release-submod-1.outputs.released == 'true'
           with:
             directory: ${{ env.SUBMODULE_1_DIR }}
@@ -1065,7 +1065,7 @@ Publish Action.
             tag: ${{ steps.release-submod-1.outputs.tag }}
 
         - name: Publish | Upload package 2 to GitHub Release Assets
-          uses: python-semantic-release/publish-action@v10.1.0
+          uses: python-semantic-release/publish-action@v10.2.0
           if: steps.release-submod-2.outputs.released == 'true'
           with:
             directory: ${{ env.SUBMODULE_2_DIR }}

{python_semantic_release-10.1.0 → python_semantic_release-10.2.0}/docs/configuration/configuration-guides/uv_integration.rst

@@ -44,18 +44,21 @@ resolve this issue depending on your preference:
 
       [tool.semantic_release]
       build_command = """
-        uv lock --offline
-        git add uv.lock
-        uv build
+          uv lock --upgrade-package "$PACKAGE_NAME"
+          git add uv.lock
+          uv build
       """
 
-    The ``--offline`` flag is used to ensure that the lock file is updated without
-    updating any dependency versions. The intent of this call is **ONLY** to update
+    The intent of the lock upgrade-package call is **ONLY** to update
     the version of your project within the lock file after PSR has updated the version
     in your project's definition file (e.g., ``pyproject.toml``). When you are running
     PSR, you have already tested the project as is and you don't want to actually
     update the dependencies if a new one just became available.
 
+    For ease of use, PSR provides the ``$PACKAGE_NAME`` environment variable that
+    contains the name of your package from the project's definition file
+    (``pyproject.toml:project.name``).
+
     If you are using the :ref:`PSR GitHub Action <gh_actions-psr>`, you will need to add an
     installation command for ``uv`` to the :ref:`build_command <config-build_command>`
     because the action runs in a Docker environment does not include ``uv`` by default.
@@ -71,21 +74,23 @@ resolve this issue depending on your preference:
 
       [tool.semantic_release]
       build_command = """
-        python -m pip install -e .[build]
-        uv lock --offline
-        git add uv.lock
-        uv build
+          python -m pip install -e '.[build]'
+          uv lock --upgrade-package "$PACKAGE_NAME"
+          git add uv.lock
+          uv build
       """
 
 #.  **Stamp the code first & then separately run release**: If you prefer to not modify the
-    build command, then you will need to run the ``uv lock --offline`` command prior to actually
-    creating the release. Essentially, you will run PSR twice: (1) once to update the version
-    in the project's definition file, and (2) a second time to generate the release.
-
-    The intent of the ``uv lock --offline`` command is **ONLY** to update the version of your
-    project within the lock file after PSR has updated the version in your project's definition
-    file (e.g., ``pyproject.toml``). When you are running PSR, you have already tested the project
-    as is and you don't want to actually update the dependencies if a new one just became available.
+    build command, then you will need to run the ``uv lock --upgrade-package <your-package-name>``
+    command prior to actually creating the release. Essentially, you will run PSR twice:
+    (1) once to update the version in the project's definition file, and (2) a second time
+    to generate the release.
+
+    The intent of the ``uv lock --upgrade-package <your-package-name>`` command is **ONLY**
+    to update the version of your project within the lock file after PSR has updated the
+    version in your project's definition file (e.g., ``pyproject.toml``). When you are
+    running PSR, you have already tested the project as is and you don't want to actually
+    update the dependencies if a new one just became available.
 
     .. code-block:: bash
 
@@ -94,7 +99,7 @@ resolve this issue depending on your preference:
       semantic-release -v version --skip-build --no-commit --no-tag --no-changelog
 
       # 2. run UV lock as pyproject.toml is updated with the next version
-      uv lock --offline
+      uv lock --upgrade-package <your-package-name>
 
       # 3. stage the lock file to ensure it is included in the PSR commit
       git add uv.lock
@@ -129,7 +134,7 @@ look like this:
 
   [tool.semantic_release]
   build_command = """
-    uv lock --offline
+    uv lock --upgrade-package "$PACKAGE_NAME"
     uv build
   """
 

{python_semantic_release-10.1.0 → python_semantic_release-10.2.0}/docs/configuration/configuration.rst

@@ -210,6 +210,7 @@ GITLAB_CI                 Pass-through ``true`` if exists in process env, unset
 HOME                      Pass-through ``HOME`` of parent process
 NEW_VERSION               Semantically determined next version (ex. ``1.2.3``)
 PATH                      Pass-through ``PATH`` of parent process
+PACKAGE_NAME              Project name as defined in ``pyproject.toml:project.name``
 PSR_DOCKER_GITHUB_ACTION  Pass-through ``true`` if exists in process env, unset otherwise
 VIRTUAL_ENV               Pass-through ``VIRTUAL_ENV`` if exists in process env, unset otherwise
 ========================  ======================================================================

{python_semantic_release-10.1.0 → python_semantic_release-10.2.0}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-semantic-release"
-version = "10.1.0"
+version = "10.2.0"
 description = "Automatic Semantic Versioning for Python projects"
 requires-python = ">=3.8"
 license = { text = "MIT" }
@@ -84,7 +84,7 @@ dev = [
   "ruff == 0.6.1"
 ]
 mypy = [
-  "mypy == 1.16.0",
+  "mypy == 1.16.1",
   "types-Deprecated ~= 1.2",
   "types-requests ~= 2.32.0",
   "types-pyyaml ~= 6.0",

{python_semantic_release-10.1.0 → python_semantic_release-10.2.0}/src/python_semantic_release.egg-info/SOURCES.txt

@@ -141,6 +141,7 @@ tests/e2e/cmd_version/bump_version/git_flow/test_repo_3_channels.py
 tests/e2e/cmd_version/bump_version/git_flow/test_repo_4_channels.py
 tests/e2e/cmd_version/bump_version/github_flow/__init__.py
 tests/e2e/cmd_version/bump_version/github_flow/test_repo_1_channel.py
+tests/e2e/cmd_version/bump_version/github_flow/test_repo_1_channel_branch_update_merge.py
 tests/e2e/cmd_version/bump_version/github_flow/test_repo_2_channels.py
 tests/e2e/cmd_version/bump_version/trunk_based_dev/__init__.py
 tests/e2e/cmd_version/bump_version/trunk_based_dev/test_repo_trunk.py
@@ -161,6 +162,7 @@ tests/fixtures/repos/git_flow/repo_w_3_release_channels.py
 tests/fixtures/repos/git_flow/repo_w_4_release_channels.py
 tests/fixtures/repos/github_flow/__init__.py
 tests/fixtures/repos/github_flow/repo_w_default_release.py
+tests/fixtures/repos/github_flow/repo_w_default_release_w_branch_update_merge.py
 tests/fixtures/repos/github_flow/repo_w_release_channels.py
 tests/fixtures/repos/trunk_based_dev/__init__.py
 tests/fixtures/repos/trunk_based_dev/repo_w_dual_version_support.py

{python_semantic_release-10.1.0 → python_semantic_release-10.2.0}/src/semantic_release/cli/commands/version.py

@@ -632,6 +632,7 @@ def version(  # noqa: C901
                     **runtime.build_command_env,
                     # PSR injected environment variables
                     "NEW_VERSION": str(new_version),
+                    "PACKAGE_NAME": runtime.project_metadata.get("name", ""),
                 },
                 noop=opts.noop,
             )

{python_semantic_release-10.1.0 → python_semantic_release-10.2.0}/tests/const.py

@@ -328,3 +328,4 @@ EXAMPLE_RELEASE_NOTES_TEMPLATE = r"""
 """.lstrip()  # noqa: E501
 
 RELEASE_NOTES = "# Release Notes"
+DEFAULT_MERGE_STRATEGY_OPTION = "theirs"

python_semantic_release-10.2.0/tests/e2e/cmd_version/bump_version/github_flow/test_repo_1_channel_branch_update_merge.py

@@ -0,0 +1,174 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+import pytest
+import tomlkit
+from flatdict import FlatDict
+from freezegun import freeze_time
+
+from tests.const import (
+    DEFAULT_BRANCH_NAME,
+)
+from tests.fixtures.repos.github_flow import (
+    repo_w_github_flow_w_default_release_n_branch_update_merge_conventional_commits,
+    repo_w_github_flow_w_default_release_n_branch_update_merge_emoji_commits,
+    repo_w_github_flow_w_default_release_n_branch_update_merge_scipy_commits,
+)
+from tests.util import temporary_working_directory
+
+if TYPE_CHECKING:
+    from pathlib import Path
+    from unittest.mock import MagicMock
+
+    from requests_mock import Mocker
+
+    from tests.e2e.cmd_version.bump_version.conftest import (
+        InitMirrorRepo4RebuildFn,
+        RunPSReleaseFn,
+    )
+    from tests.e2e.conftest import GetSanitizedChangelogContentFn
+    from tests.fixtures.example_project import ExProjectDir
+    from tests.fixtures.git_repo import (
+        BuildRepoFromDefinitionFn,
+        BuildSpecificRepoFn,
+        CommitConvention,
+        GetGitRepo4DirFn,
+        RepoActionConfigure,
+        RepoActionRelease,
+        RepoActions,
+        SplitRepoActionsByReleaseTagsFn,
+    )
+
+
+@pytest.mark.xfail(
+    reason="Should pass after [#1252](https://github.com/python-semantic-release/python-semantic-release/issues/1252) is fixed",
+)
+@pytest.mark.parametrize(
+    "repo_fixture_name",
+    [
+        pytest.param(repo_fixture_name, marks=pytest.mark.comprehensive)
+        for repo_fixture_name in [
+            repo_w_github_flow_w_default_release_n_branch_update_merge_conventional_commits.__name__,
+            repo_w_github_flow_w_default_release_n_branch_update_merge_emoji_commits.__name__,
+            repo_w_github_flow_w_default_release_n_branch_update_merge_scipy_commits.__name__,
+        ]
+    ],
+)
+def test_github_flow_repo_w_default_release_n_branch_update_merge(
+    repo_fixture_name: str,
+    run_psr_release: RunPSReleaseFn,
+    build_github_flow_repo_w_default_release_n_branch_update_merge: BuildSpecificRepoFn,
+    split_repo_actions_by_release_tags: SplitRepoActionsByReleaseTagsFn,
+    init_mirror_repo_for_rebuild: InitMirrorRepo4RebuildFn,
+    example_project_dir: ExProjectDir,
+    git_repo_for_directory: GetGitRepo4DirFn,
+    build_repo_from_definition: BuildRepoFromDefinitionFn,
+    mocked_git_push: MagicMock,
+    post_mocker: Mocker,
+    default_tag_format_str: str,
+    version_py_file: Path,
+    get_sanitized_md_changelog_content: GetSanitizedChangelogContentFn,
+    get_sanitized_rst_changelog_content: GetSanitizedChangelogContentFn,
+):
+    # build target repo into a temporary directory
+    target_repo_dir = example_project_dir / repo_fixture_name
+    commit_type: CommitConvention = (
+        repo_fixture_name.split("commits", 1)[0].split("_")[-2]  # type: ignore[assignment]
+    )
+    target_repo_definition = (
+        build_github_flow_repo_w_default_release_n_branch_update_merge(
+            repo_name=repo_fixture_name,
+            commit_type=commit_type,
+            dest_dir=target_repo_dir,
+        )
+    )
+    target_git_repo = git_repo_for_directory(target_repo_dir)
+    target_repo_pyproject_toml = FlatDict(
+        tomlkit.loads((target_repo_dir / "pyproject.toml").read_text(encoding="utf-8")),
+        delimiter=".",
+    )
+    tag_format_str: str = target_repo_pyproject_toml.get(  # type: ignore[assignment]
+        "tool.semantic_release.tag_format",
+        default_tag_format_str,
+    )
+
+    # split repo actions by release actions
+    releasetags_2_steps: dict[str, list[RepoActions]] = (
+        split_repo_actions_by_release_tags(target_repo_definition, tag_format_str)
+    )
+    configuration_step: RepoActionConfigure = releasetags_2_steps.pop("")[0]  # type: ignore[assignment]
+
+    # Create the mirror repo directory
+    mirror_repo_dir = init_mirror_repo_for_rebuild(
+        mirror_repo_dir=(example_project_dir / "mirror"),
+        configuration_step=configuration_step,
+    )
+    mirror_git_repo = git_repo_for_directory(mirror_repo_dir)
+
+    # rebuild repo from scratch stopping before each release tag
+    for curr_release_tag, steps in releasetags_2_steps.items():
+        # make sure mocks are clear
+        mocked_git_push.reset_mock()
+        post_mocker.reset_mock()
+
+        # Extract expected result from target repo
+        head_reference_name = (
+            curr_release_tag
+            if curr_release_tag != "Unreleased"
+            else DEFAULT_BRANCH_NAME
+        )
+        target_git_repo.git.checkout(head_reference_name, detach=True)
+        expected_md_changelog_content = get_sanitized_md_changelog_content(
+            repo_dir=target_repo_dir
+        )
+        expected_rst_changelog_content = get_sanitized_rst_changelog_content(
+            repo_dir=target_repo_dir
+        )
+        expected_pyproject_toml_content = (
+            target_repo_dir / "pyproject.toml"
+        ).read_text()
+        expected_version_file_content = (target_repo_dir / version_py_file).read_text()
+        expected_release_commit_text = target_git_repo.head.commit.message
+
+        # In our repo env, start building the repo from the definition
+        build_repo_from_definition(
+            dest_dir=mirror_repo_dir,
+            repo_construction_steps=steps[:-1],  # stop before the release step
+        )
+        release_action_step: RepoActionRelease = steps[-1]  # type: ignore[assignment]
+
+        # Act: run PSR on the repo instead of the RELEASE step
+        with freeze_time(
+            release_action_step["details"]["datetime"]
+        ), temporary_working_directory(mirror_repo_dir):
+            run_psr_release(
+                next_version_str=release_action_step["details"]["version"],
+                git_repo=mirror_git_repo,
+            )
+
+        # take measurement after running the version command
+        actual_release_commit_text = mirror_git_repo.head.commit.message
+        actual_pyproject_toml_content = (mirror_repo_dir / "pyproject.toml").read_text()
+        actual_version_file_content = (mirror_repo_dir / version_py_file).read_text()
+        actual_md_changelog_content = get_sanitized_md_changelog_content(
+            repo_dir=mirror_repo_dir
+        )
+        actual_rst_changelog_content = get_sanitized_rst_changelog_content(
+            repo_dir=mirror_repo_dir
+        )
+
+        # Evaluate (normal release actions should have occurred as expected)
+        # ------------------------------------------------------------------
+        # Make sure version file is updated
+        assert expected_pyproject_toml_content == actual_pyproject_toml_content
+        assert expected_version_file_content == actual_version_file_content
+        # Make sure changelog is updated
+        assert expected_md_changelog_content == actual_md_changelog_content
+        assert expected_rst_changelog_content == actual_rst_changelog_content
+        # Make sure commit is created
+        assert expected_release_commit_text == actual_release_commit_text
+        # Make sure tag is created
+        assert curr_release_tag in [tag.name for tag in mirror_git_repo.tags]
+        assert mocked_git_push.call_count == 2  # 1 for commit, 1 for tag
+        assert post_mocker.call_count == 1  # vcs release creation occured

{python_semantic_release-10.1.0 → python_semantic_release-10.2.0}/tests/e2e/cmd_version/test_version_build.py

@@ -109,6 +109,7 @@ def test_version_runs_build_command(
             check=True,
             env={
                 "NEW_VERSION": next_release_version,  # injected into environment
+                "PACKAGE_NAME": "",  # PSR injected environment variable
                 "CI": patched_os_environment["CI"],
                 "BITBUCKET_CI": "true",  # Converted
                 "GITHUB_ACTIONS": patched_os_environment["GITHUB_ACTIONS"],
@@ -168,6 +169,8 @@ def test_version_runs_build_command_windows(
         )
 
     # Setup
+    package_name = "my-package"
+    update_pyproject_toml("project.name", package_name)
     built_wheel_file = get_wheel_file(next_release_version)
     pyproject_config = FlatDict(
         tomlkit.loads(example_pyproject_toml.read_text(encoding="utf-8")),
@@ -205,6 +208,7 @@ def test_version_runs_build_command_windows(
             env={
                 **clean_os_environment,
                 "NEW_VERSION": next_release_version,  # injected into environment
+                "PACKAGE_NAME": package_name,  # PSR injected environment variable
                 "CI": patched_os_environment["CI"],
                 "BITBUCKET_CI": "true",  # Converted
                 "GITHUB_ACTIONS": patched_os_environment["GITHUB_ACTIONS"],
@@ -276,6 +280,8 @@ def test_version_runs_build_command_w_user_env(
             "=ignored-invalid-named-var",  # TODO: validation error instead, but currently just ignore
         ],
     )
+    package_name = "my-package"
+    update_pyproject_toml("project.name", package_name)
 
     # Mock out subprocess.run
     with mock.patch(
@@ -309,6 +315,7 @@ def test_version_runs_build_command_w_user_env(
             env={
                 **clean_os_environment,
                 "NEW_VERSION": next_release_version,  # injected into environment
+                "PACKAGE_NAME": package_name,  # PSR injected environment variable
                 "CI": patched_os_environment["CI"],
                 "BITBUCKET_CI": "true",  # Converted
                 "GITHUB_ACTIONS": patched_os_environment["GITHUB_ACTIONS"],

{python_semantic_release-10.1.0 → python_semantic_release-10.2.0}/tests/fixtures/git_repo.py

@@ -33,6 +33,7 @@ import tests.util
 from tests.const import (
     COMMIT_MESSAGE,
     DEFAULT_BRANCH_NAME,
+    DEFAULT_MERGE_STRATEGY_OPTION,
     EXAMPLE_HVCS_DOMAIN,
     EXAMPLE_REPO_NAME,
     EXAMPLE_REPO_OWNER,
@@ -233,6 +234,7 @@ if TYPE_CHECKING:
             branch_name: str,
             commit_def: CommitDef,
             fast_forward: bool = True,
+            strategy_option: str = DEFAULT_MERGE_STRATEGY_OPTION,
         ) -> CommitDef: ...
 
     class CreateSquashMergeCommitFn(Protocol):
@@ -241,7 +243,7 @@ if TYPE_CHECKING:
             git_repo: Repo,
             branch_name: str,
             commit_def: CommitDef,
-            strategy_option: str = "theirs",
+            strategy_option: str = DEFAULT_MERGE_STRATEGY_OPTION,
         ) -> CommitDef: ...
 
     class CommitSpec(TypedDict):
@@ -311,7 +313,7 @@ if TYPE_CHECKING:
         branch_name: str
         commit_def: CommitDef
         fast_forward: Literal[False]
-        # strategy_option: str
+        strategy_option: NotRequired[str]
 
     class RepoActionGitFFMergeDetails(DetailsBase):
         branch_name: str
@@ -763,6 +765,7 @@ def create_merge_commit(stable_now_date: GetStableDateNowFn) -> CreateMergeCommi
         branch_name: str,
         commit_def: CommitDef,
         fast_forward: bool = True,
+        strategy_option: str = DEFAULT_MERGE_STRATEGY_OPTION,
     ) -> CommitDef:
         curr_dt = stable_now_date()
         commit_dt = (
@@ -784,6 +787,7 @@ def create_merge_commit(stable_now_date: GetStableDateNowFn) -> CreateMergeCommi
                 ff=fast_forward,
                 no_ff=bool(not fast_forward),
                 m=commit_def["msg"],
+                strategy_option=strategy_option,
             )
 
         # return the commit definition with the sha & message updated
@@ -804,7 +808,7 @@ def create_squash_merge_commit(
         git_repo: Repo,
         branch_name: str,
         commit_def: CommitDef,
-        strategy_option: str = "theirs",
+        strategy_option: str = DEFAULT_MERGE_STRATEGY_OPTION,
     ) -> CommitDef:
         curr_dt = stable_now_date()
         commit_dt = (
@@ -1404,6 +1408,9 @@ def build_repo_from_definition(  # noqa: C901, its required and its just test co
                                 branch_name=merge_def["branch_name"],
                                 commit_def=merge_def["commit_def"],
                                 fast_forward=merge_def["fast_forward"],
+                                strategy_option=merge_def.get(
+                                    "strategy_option", DEFAULT_MERGE_STRATEGY_OPTION
+                                ),
                             )
                             if merge_def["commit_def"]["include_in_changelog"]:
                                 current_commits.append(merge_def["commit_def"])

{python_semantic_release-10.1.0 → python_semantic_release-10.2.0}/tests/fixtures/repos/github_flow/__init__.py

@@ -1,2 +1,3 @@
 from tests.fixtures.repos.github_flow.repo_w_default_release import *
+from tests.fixtures.repos.github_flow.repo_w_default_release_w_branch_update_merge import *
 from tests.fixtures.repos.github_flow.repo_w_release_channels import *