python-semantic-release 10.5.1__tar.gz → 10.5.2__tar.gz

{python_semantic_release-10.5.1 → python_semantic_release-10.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-semantic-release
-Version: 10.5.1
+Version: 10.5.2
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>, codejedi365 <codejedi365@gmail.com>
 License: MIT

{python_semantic_release-10.5.1 → python_semantic_release-10.5.2}/docs/configuration/automatic-releases/github-actions.rst

@@ -893,14 +893,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.5.1
+            uses: python-semantic-release/python-semantic-release@v10.5.2
             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.5.1
+            uses: python-semantic-release/publish-action@v10.5.2
             if: steps.release.outputs.released == 'true'
             with:
               github_token: ${{ secrets.GITHUB_TOKEN }}
@@ -1005,7 +1005,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.5.1
+    uses: python-semantic-release/python-semantic-release@v10.5.2
     with:
       github_token: ${{ secrets.GITHUB_TOKEN }}
       force: patch
@@ -1064,14 +1064,14 @@ Publish Action.
 
         - name: Release submodule 1
           id: release-submod-1
-          uses: python-semantic-release/python-semantic-release@v10.5.1
+          uses: python-semantic-release/python-semantic-release@v10.5.2
           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.5.1
+          uses: python-semantic-release/python-semantic-release@v10.5.2
           with:
             directory: ${{ env.SUBMODULE_2_DIR }}
             github_token: ${{ secrets.GITHUB_TOKEN }}
@@ -1083,7 +1083,7 @@ Publish Action.
         # ------------------------------------------------------------------- #
 
         - name: Publish | Upload package 1 to GitHub Release Assets
-          uses: python-semantic-release/publish-action@v10.5.1
+          uses: python-semantic-release/publish-action@v10.5.2
           if: steps.release-submod-1.outputs.released == 'true'
           with:
             directory: ${{ env.SUBMODULE_1_DIR }}
@@ -1091,7 +1091,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.5.1
+          uses: python-semantic-release/publish-action@v10.5.2
           if: steps.release-submod-2.outputs.released == 'true'
           with:
             directory: ${{ env.SUBMODULE_2_DIR }}

{python_semantic_release-10.5.1 → python_semantic_release-10.5.2}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-semantic-release"
-version = "10.5.1"
+version = "10.5.2"
 description = "Automatic Semantic Versioning for Python projects"
 requires-python = "~= 3.8"
 license = { text = "MIT" }

{python_semantic_release-10.5.1 → python_semantic_release-10.5.2}/src/semantic_release/cli/commands/version.py

@@ -722,6 +722,7 @@ def version(  # noqa: C901
             )
         except GitCommitEmptyIndexError:
             logger.info("No local changes to add to any commit, skipping")
+            commit_changes = False
 
     # Tag the version after potentially creating a new HEAD commit.
     # This way if no source code is modified, i.e. all metadata updates

{python_semantic_release-10.5.1 → python_semantic_release-10.5.2}/tests/conftest.py

@@ -206,6 +206,10 @@ def run_cli(clean_os_environment: dict[str, str]) -> RunCliFn:
         invoke_kwargs: dict[str, Any] | None = None,
     ) -> Result:
         from semantic_release.cli.commands.main import main
+        from semantic_release.globals import logger
+
+        # Prevent logs from being propagated to the root logger (pytest)
+        logger.propagate = False
 
         cli_runner = CliRunner(mix_stderr=False)
         env_vars = {**clean_os_environment, **(env or {})}
@@ -213,7 +217,11 @@ def run_cli(clean_os_environment: dict[str, str]) -> RunCliFn:
 
         with mock.patch.dict(os.environ, env_vars, clear=True):
             # run the CLI with the provided arguments
-            return cli_runner.invoke(main, args=args, **(invoke_kwargs or {}))
+            result = cli_runner.invoke(main, args=args, **(invoke_kwargs or {}))
+            # Force the output to be printed to stdout which will be captured by pytest
+            sys.stdout.write(result.stdout)
+            sys.stderr.write(result.stderr)
+            return result
 
     return _run_cli
 

{python_semantic_release-10.5.1 → python_semantic_release-10.5.2}/tests/e2e/cmd_version/test_version_print.py

@@ -105,7 +105,6 @@ def test_version_print_next_version(
     next_release_version: str,
     file_in_repo: str,
     run_cli: RunCliFn,
-    mocked_git_fetch: MagicMock,
     mocked_git_push: MagicMock,
     post_mocker: Mocker,
 ):
@@ -270,7 +269,6 @@ def test_version_print_tag_prints_next_tag(
     get_cfg_value_from_def: GetCfgValueFromDefFn,
     file_in_repo: str,
     run_cli: RunCliFn,
-    mocked_git_fetch: MagicMock,
     mocked_git_push: MagicMock,
     post_mocker: Mocker,
 ):
@@ -386,7 +384,6 @@ def test_version_print_tag_prints_next_tag_no_zero_versions(
     get_cfg_value_from_def: GetCfgValueFromDefFn,
     file_in_repo: str,
     run_cli: RunCliFn,
-    mocked_git_fetch: MagicMock,
     mocked_git_push: MagicMock,
     post_mocker: Mocker,
 ):
@@ -450,7 +447,6 @@ def test_version_print_last_released_prints_version(
     repo_result: BuiltRepoResult,
     get_versions_from_repo_build_def: GetVersionsFromRepoBuildDefFn,
     run_cli: RunCliFn,
-    mocked_git_fetch: MagicMock,
     mocked_git_push: MagicMock,
     post_mocker: Mocker,
     strip_logging_messages: StripLoggingMessagesFn,
@@ -502,7 +498,6 @@ def test_version_print_last_released_prints_released_if_commits(
     get_versions_from_repo_build_def: GetVersionsFromRepoBuildDefFn,
     commits: list[str],
     run_cli: RunCliFn,
-    mocked_git_fetch: MagicMock,
     mocked_git_push: MagicMock,
     post_mocker: Mocker,
     file_in_repo: str,
@@ -552,10 +547,8 @@ def test_version_print_last_released_prints_released_if_commits(
 def test_version_print_last_released_prints_nothing_if_no_tags(
     repo_result: BuiltRepoResult,
     run_cli: RunCliFn,
-    mocked_git_fetch: MagicMock,
     mocked_git_push: MagicMock,
     post_mocker: Mocker,
-    caplog: pytest.LogCaptureFixture,
 ):
     repo = repo_result["repo"]
 
@@ -577,10 +570,7 @@ def test_version_print_last_released_prints_nothing_if_no_tags(
     # Evaluate (no release actions should have occurred on print)
     assert_successful_exit_code(result, cli_cmd)
     assert result.stdout == ""
-
-    # must use capture log to see this, because we use the logger to print this message
-    # not click's output
-    assert "No release tags found." in caplog.text
+    assert "No release tags found." in result.stderr
 
     # assert nothing else happened (no code changes, no commit, no tag, no push, no vcs release)
     assert repo_status_before == repo_status_after
@@ -598,7 +588,6 @@ def test_version_print_last_released_on_detached_head(
     repo_result: BuiltRepoResult,
     get_versions_from_repo_build_def: GetVersionsFromRepoBuildDefFn,
     run_cli: RunCliFn,
-    mocked_git_fetch: MagicMock,
     mocked_git_push: MagicMock,
     post_mocker: Mocker,
     strip_logging_messages: StripLoggingMessagesFn,
@@ -647,7 +636,6 @@ def test_version_print_last_released_on_nonrelease_branch(
     repo_result: BuiltRepoResult,
     get_versions_from_repo_build_def: GetVersionsFromRepoBuildDefFn,
     run_cli: RunCliFn,
-    mocked_git_fetch: MagicMock,
     mocked_git_push: MagicMock,
     post_mocker: Mocker,
     strip_logging_messages: StripLoggingMessagesFn,
@@ -705,7 +693,6 @@ def test_version_print_last_released_tag_prints_correct_tag(
     get_cfg_value_from_def: GetCfgValueFromDefFn,
     get_versions_from_repo_build_def: GetVersionsFromRepoBuildDefFn,
     run_cli: RunCliFn,
-    mocked_git_fetch: MagicMock,
     mocked_git_push: MagicMock,
     post_mocker: Mocker,
     strip_logging_messages: StripLoggingMessagesFn,
@@ -766,7 +753,6 @@ def test_version_print_last_released_tag_prints_released_if_commits(
     get_versions_from_repo_build_def: GetVersionsFromRepoBuildDefFn,
     commits: list[str],
     run_cli: RunCliFn,
-    mocked_git_fetch: MagicMock,
     mocked_git_push: MagicMock,
     post_mocker: Mocker,
     file_in_repo: str,
@@ -817,10 +803,8 @@ def test_version_print_last_released_tag_prints_released_if_commits(
 def test_version_print_last_released_tag_prints_nothing_if_no_tags(
     repo_result: BuiltRepoResult,
     run_cli: RunCliFn,
-    mocked_git_fetch: MagicMock,
     mocked_git_push: MagicMock,
     post_mocker: Mocker,
-    caplog: pytest.LogCaptureFixture,
 ):
     repo = repo_result["repo"]
 
@@ -842,10 +826,7 @@ def test_version_print_last_released_tag_prints_nothing_if_no_tags(
     # Evaluate (no release actions should have occurred on print)
     assert_successful_exit_code(result, cli_cmd)
     assert result.stdout == ""
-
-    # must use capture log to see this, because we use the logger to print this message
-    # not click's output
-    assert "No release tags found." in caplog.text
+    assert "No release tags found." in result.stderr
 
     # assert nothing else happened (no code changes, no commit, no tag, no push, no vcs release)
     assert repo_status_before == repo_status_after
@@ -872,7 +853,6 @@ def test_version_print_last_released_tag_on_detached_head(
     get_cfg_value_from_def: GetCfgValueFromDefFn,
     get_versions_from_repo_build_def: GetVersionsFromRepoBuildDefFn,
     run_cli: RunCliFn,
-    mocked_git_fetch: MagicMock,
     mocked_git_push: MagicMock,
     post_mocker: Mocker,
     strip_logging_messages: StripLoggingMessagesFn,
@@ -931,7 +911,6 @@ def test_version_print_last_released_tag_on_nonrelease_branch(
     get_cfg_value_from_def: GetCfgValueFromDefFn,
     get_versions_from_repo_build_def: GetVersionsFromRepoBuildDefFn,
     run_cli: RunCliFn,
-    mocked_git_fetch: MagicMock,
     mocked_git_push: MagicMock,
     post_mocker: Mocker,
     strip_logging_messages: StripLoggingMessagesFn,
@@ -989,7 +968,6 @@ def test_version_print_next_version_fails_on_detached_head(
     simulate_change_commits_n_rtn_changelog_entry: SimulateChangeCommitsNReturnChangelogEntryFn,
     get_commit_def_fn: GetCommitDefFn[CommitParser[ParseResult, ParserOptions]],
     default_parser: CommitParser[ParseResult, ParserOptions],
-    mocked_git_fetch: MagicMock,
     mocked_git_push: MagicMock,
     post_mocker: Mocker,
     strip_logging_messages: StripLoggingMessagesFn,
@@ -1052,7 +1030,6 @@ def test_version_print_next_tag_fails_on_detached_head(
     simulate_change_commits_n_rtn_changelog_entry: SimulateChangeCommitsNReturnChangelogEntryFn,
     get_commit_def_fn: GetCommitDefFn[CommitParser[ParseResult, ParserOptions]],
     default_parser: CommitParser[ParseResult, ParserOptions],
-    mocked_git_fetch: MagicMock,
     mocked_git_push: MagicMock,
     post_mocker: Mocker,
     strip_logging_messages: StripLoggingMessagesFn,

{python_semantic_release-10.5.1 → python_semantic_release-10.5.2}/tests/e2e/cmd_version/test_version_upstream_check.py

@@ -291,6 +291,165 @@ def test_version_upstream_check_success_no_changes_untracked_branch(
     assert expected_vcs_url_post == post_mocker.call_count  # one vcs release created
 
 
+@pytest.mark.parametrize(
+    "repo_fixture_name, build_repo_fn",
+    [
+        (
+            repo_fixture_name,
+            lazy_fixture(build_repo_fn_name),
+        )
+        for repo_fixture_name, build_repo_fn_name in [
+            (
+                repo_w_trunk_only_conventional_commits.__name__,
+                build_trunk_only_repo_w_tags.__name__,
+            ),
+        ]
+    ],
+)
+@pytest.mark.usefixtures(change_to_ex_proj_dir.__name__)
+def test_version_no_upstream_check_on_no_version_commit(
+    repo_fixture_name: str,
+    run_cli: RunCliFn,
+    build_repo_fn: BuildSpecificRepoFn,
+    example_project_dir: ExProjectDir,
+    git_repo_for_directory: GetGitRepo4DirFn,
+    post_mocker: Mocker,
+    get_cfg_value_from_def: GetCfgValueFromDefFn,
+    get_versions_from_repo_build_def: GetVersionsFromRepoBuildDefFn,
+    pyproject_toml_file: Path,
+    update_pyproject_toml: UpdatePyprojectTomlFn,
+):
+    """
+    Test that PSR succeeds when no version commit is needed, so the upstream check is skipped.
+
+    This replicates the scenario that occurred on python-semantic-release/publish-action@v10.5.1
+    where the version command was run and no version commit was needed, but it failed because
+    it attempted to check the upstream branch anyway and we hard coded HEAD~1 because it expects
+    a version commit to be created. This is the only reason why you would check the upstream branch
+    because pushing a tag to the remote can happen even if the upstream branch has changed.
+    """
+    remote_name = "origin"
+    # Create a bare remote (simulating origin)
+    local_origin = Repo.init(str(example_project_dir / "local_origin"), bare=True)
+
+    # 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_repo_fn(
+        repo_name=repo_fixture_name,
+        commit_type=commit_type,
+        dest_dir=target_repo_dir,
+    )
+    target_git_repo = git_repo_for_directory(target_repo_dir)
+
+    # Configure the source repo to use the bare remote (removing any existing 'origin')
+    with contextlib.suppress(AttributeError):
+        target_git_repo.delete_remote(target_git_repo.remotes[remote_name])
+
+    target_git_repo.create_remote(remote_name, str(local_origin.working_dir))
+
+    # Remove last release before pushing to upstream
+    tag_format_str = cast(
+        "str", get_cfg_value_from_def(target_repo_definition, "tag_format_str")
+    )
+    latest_tag = tag_format_str.format(
+        version=get_versions_from_repo_build_def(target_repo_definition)[-1]
+    )
+    target_git_repo.git.tag("-d", latest_tag)
+    target_git_repo.git.reset("--hard", "HEAD~1")
+
+    # Remove any version variables to ensure no version commit is needed
+    update_pyproject_toml(
+        "tool.semantic_release.version_variables",
+        None,
+        target_repo_dir / pyproject_toml_file,
+    )
+    update_pyproject_toml(
+        "tool.semantic_release.version_toml",
+        None,
+        target_repo_dir / pyproject_toml_file,
+    )
+    # TODO: when available, switch this to use hvcs=none or similar config to avoid token use for push
+    update_pyproject_toml(
+        "tool.semantic_release.remote.ignore_token_for_push",
+        True,
+        target_repo_dir / pyproject_toml_file,
+    )
+    target_git_repo.git.commit(amend=True, no_edit=True, all=True)
+
+    # push the current state to establish the remote (cannot push tags and branches at the same time)
+    target_git_repo.git.push(remote_name, all=True)  # all branches
+    target_git_repo.git.push(remote_name, tags=True)  # all tags
+
+    # ensure bare remote HEAD points to the active branch so clones can checkout
+    local_origin.git.symbolic_ref(
+        "HEAD", f"refs/heads/{target_git_repo.active_branch.name}"
+    )
+
+    # Simulate CI environment after someone pushes to the repo
+    ci_commit_sha = target_git_repo.head.commit.hexsha
+    ci_branch = target_git_repo.active_branch.name
+
+    # current remote tags
+    remote_origin_tags_before = {tag.name for tag in local_origin.tags}
+
+    # Simulate a CI environment by fetching the repo to a new location
+    test_repo = Repo.init(str(example_project_dir / "ci_repo"))
+    with test_repo.config_writer("repository") as config:
+        config.set_value("core", "hookspath", "")
+        config.set_value("commit", "gpgsign", False)
+        config.set_value("tag", "gpgsign", False)
+
+    # Configure and retrieve the repository (see GitHub actions/checkout@v5)
+    test_repo.git.remote(
+        "add",
+        remote_name,
+        f"file:///{PureWindowsPath(local_origin.working_dir).as_posix()}",
+    )
+    test_repo.git.fetch("--depth=1", remote_name, ci_commit_sha)
+
+    # Simulate CI environment and recommended workflow (in docs)
+    # NOTE: this could be done in 1 step, but most CI pipelines are doing it in 2 steps
+    # 1. Checkout the commit sha (detached head)
+    test_repo.git.checkout(ci_commit_sha, force=True)
+    # 2. Forcefully set the branch to the current detached head
+    test_repo.git.checkout("-B", ci_branch)
+
+    # Act: run PSR on the cloned repo - it should verify upstream and succeed
+    with temporary_working_directory(str(test_repo.working_dir)):
+        # We don't use `--no-commit` here because we want to test that the upstream check is skipped
+        # when PSR determines that no version commit is needed. If we used `--no-commit`, it would skip the
+        # upstream check because it would think that a version commit was not needed.
+        cli_cmd = [
+            MAIN_PROG_NAME,
+            "--strict",
+            VERSION_SUBCMD,
+            "--no-changelog",
+            "--skip-build",
+        ]
+        result = run_cli(cli_cmd[1:], env={Github.DEFAULT_ENV_TOKEN_NAME: "1234"})
+
+    remote_origin_tags_after = {tag.name for tag in local_origin.tags}
+
+    # Evaluate
+    assert_successful_exit_code(result, cli_cmd)
+
+    # Verify release occurred as expected
+    with test_repo:
+        assert latest_tag in test_repo.tags, "Expected release tag to be created"
+        assert (
+            ci_commit_sha == test_repo.head.commit.hexsha
+        ), "Expected no new commit to be created on HEAD"
+        different_tags = remote_origin_tags_after.difference(remote_origin_tags_before)
+        assert latest_tag in different_tags, "Expected new tag to be pushed to remote"
+
+    # Verify VCS release was created
+    expected_vcs_url_post = 1
+    assert expected_vcs_url_post == post_mocker.call_count  # one vcs release created
+
+
 @pytest.mark.parametrize(
     "repo_fixture_name, build_repo_fn",
     [

{python_semantic_release-10.5.1 → python_semantic_release-10.5.2}/tests/util.py

@@ -58,26 +58,21 @@ def get_func_qual_name(func: Callable) -> str:
 def assert_exit_code(
     exit_code: int, result: ClickInvokeResult, cli_cmd: list[str]
 ) -> bool:
-    if result.exit_code != exit_code:
-        raise AssertionError(
-            str.join(
-                os.linesep,
-                [
-                    f"{result.exit_code} != {exit_code} (actual != expected)",
-                    "",
-                    # Explain what command failed
-                    "Unexpected exit code from command:",
-                    indent(f"'{str.join(' ', cli_cmd)}'", " " * 2),
-                    "",
-                    # Add indentation to each line for stdout & stderr
-                    "stdout:",
-                    indent(result.stdout, " " * 2) if result.stdout.strip() else "",
-                    "stderr:",
-                    indent(result.stderr, " " * 2) if result.stderr.strip() else "",
-                ],
-            )
+    if result.exit_code == exit_code:
+        return True
+
+    raise AssertionError(
+        str.join(
+            os.linesep,
+            [
+                f"{result.exit_code} != {exit_code} (actual != expected)",
+                "",
+                # Explain what command failed
+                "Unexpected exit code from command:",
+                indent(f"'{str.join(' ', cli_cmd)}'", " " * 2),
+            ],
         )
-    return True
+    )
 
 
 def assert_successful_exit_code(result: ClickInvokeResult, cli_cmd: list[str]) -> bool: