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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-semantic-release
-Version: 10.5.0
+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.0 → 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.0
+            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.0
+            uses: python-semantic-release/publish-action@v10.5.2
             if: steps.release.outputs.released == 'true'
             with:
               github_token: ${{ secrets.GITHUB_TOKEN }}
@@ -969,7 +969,7 @@ to the GitHub Release Assets as well.
   the ``token`` input) in order to gain push access.
 
 .. note::
-  As of $NEW_RELEASE_TAG, Python Semantic Release automatically detects and converts
+  As of v10.5.0, Python Semantic Release automatically detects and converts
   shallow clones to full clones when needed. While you can still use ``fetch-depth: 0``
   with ``actions/checkout@v4`` to fetch the full history upfront, it is no longer
   required. If you use the default shallow clone, Python Semantic Release will
@@ -977,7 +977,7 @@ to the GitHub Release Assets as well.
   an older version of PSR, you will need to unshallow the repository prior to use.
 
 .. note::
-  As of $NEW_RELEASE_TAG, the verify upstream step is no longer required as it has been
+  As of v10.5.0, the verify upstream step is no longer required as it has been
   integrated into PSR directly. If you are using an older version of PSR, you will need
   to review the older documentation for that step. See Issue `#1201`_ for more details.
 
@@ -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.0
+    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.0
+          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.0
+          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.0
+          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.0
+          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.0 → python_semantic_release-10.5.2}/docs/configuration/configuration.rst

@@ -1398,7 +1398,7 @@ The regular expression generated from the ``version_variables`` definition will:
 2. The variable name defined by ``variable`` and the version must be separated by
    an operand symbol (``=``, ``:``, ``:=``, or ``@``). Whitespace is optional around
    the symbol. As of v10.0.0, a double-equals (``==``) operator is also supported
-   as a valid operand symbol. As of $NEW_RELEASE_TAG, PSR can omit all operands as long
+   as a valid operand symbol. As of v10.5.0, PSR can omit all operands as long
    as there is at least one whitespace character between the variable name and the version.
 
 3. The value of the variable must match a `SemVer`_ regular expression and can be

{python_semantic_release-10.5.0 → 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.0"
+version = "10.5.2"
 description = "Automatic Semantic Versioning for Python projects"
 requires-python = "~= 3.8"
 license = { text = "MIT" }

{python_semantic_release-10.5.0 → 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
@@ -749,7 +750,11 @@ def version(  # noqa: C901
             # This prevents conflicts if another commit was pushed while we were preparing the release
             # We check HEAD~1 because we just made a release commit
             try:
-                project.verify_upstream_unchanged(local_ref="HEAD~1", noop=opts.noop)
+                project.verify_upstream_unchanged(
+                    local_ref="HEAD~1",
+                    upstream_ref=config.remote.name,
+                    noop=opts.noop,
+                )
             except UpstreamBranchChangedError as exc:
                 click.echo(str(exc), err=True)
                 click.echo(

{python_semantic_release-10.5.0 → python_semantic_release-10.5.2}/src/semantic_release/gitproject.py

@@ -335,17 +335,23 @@ class GitProject:
                 self.logger.exception(str(err))
                 raise GitPushError(f"Failed to push tag ({tag}) to remote") from err
 
-    def verify_upstream_unchanged(
-        self, local_ref: str = "HEAD", noop: bool = False
+    def verify_upstream_unchanged(  # noqa: C901
+        self, local_ref: str = "HEAD", upstream_ref: str = "origin", noop: bool = False
     ) -> None:
         """
         Verify that the upstream branch has not changed since the given local reference.
 
         :param local_ref: The local reference to compare against upstream (default: HEAD)
+        :param upstream_ref: The name of the upstream remote or specific remote branch (default: origin)
         :param noop: Whether to skip the actual verification (for dry-run mode)
 
         :raises UpstreamBranchChangedError: If the upstream branch has changed
         """
+        if not local_ref.strip():
+            raise ValueError("Local reference cannot be empty")
+        if not upstream_ref.strip():
+            raise ValueError("Upstream reference cannot be empty")
+
         if noop:
             noop_report(
                 indented(
@@ -368,12 +374,30 @@ class GitProject:
                 raise DetachedHeadGitError(err_msg) from None
 
             # Get the tracking branch (upstream branch)
-            if (tracking_branch := active_branch.tracking_branch()) is None:
-                err_msg = f"No upstream branch found for '{active_branch.name}'; cannot verify upstream state!"
-                raise UnknownUpstreamBranchError(err_msg)
+            if (tracking_branch := active_branch.tracking_branch()) is not None:
+                upstream_full_ref_name = tracking_branch.name
+                self.logger.info("Upstream branch name: %s", upstream_full_ref_name)
+            else:
+                # If no tracking branch is set, derive it
+                upstream_name = (
+                    upstream_ref.strip()
+                    if upstream_ref.find("/") == -1
+                    else upstream_ref.strip().split("/", maxsplit=1)[0]
+                )
+
+                if not repo.remotes or upstream_name not in repo.remotes:
+                    err_msg = "No remote found; cannot verify upstream state!"
+                    raise UnknownUpstreamBranchError(err_msg)
+
+                upstream_full_ref_name = (
+                    f"{upstream_name}/{active_branch.name}"
+                    if upstream_ref.find("/") == -1
+                    else upstream_ref.strip()
+                )
 
-            upstream_full_ref_name = tracking_branch.name
-            self.logger.info("Upstream branch name: %s", upstream_full_ref_name)
+                if upstream_full_ref_name not in repo.refs:
+                    err_msg = f"No upstream branch found for '{active_branch.name}'; cannot verify upstream state!"
+                    raise UnknownUpstreamBranchError(err_msg)
 
             # Extract the remote name from the tracking branch
             # tracking_branch.name is in the format "remote/branch"

{python_semantic_release-10.5.0 → 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.0 → 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,