fix(config): eliminate .git/ in parent dir warnings for monorepos configured with .. (#1444)

In monorepo setups where `repo_dir = '..'` is configured for a subpackage,
`Path('..').absolute()` returns `/path/to/package/..` rather than the resolved
`/path/to/repo`. This change resolves symlinks and normalizes paths, preventing
additional `'Found .git/ in higher parent directory'` warnings.

Resolves: #1418

* docs(configuration): document `repo_dir` config option

* test(fixtures): update example monorepo to configure `repo_dir` as parent dir

* test(cmd-version): update rebuild repo tests to check for `.git/` in parent dir warning

* test(cmd-version): add e2e test to check for warning of `.git/` in parent dir

* test(fixtures): adjust change directory for windows compatibility

---------

Co-authored-by: Aniket Karne <aniketkarne@gmail.com>
Co-authored-by: codejedi365 <codejedi365@users.noreply.github.com>
Signed-off-by: codejedi365 <codejedi365@users.noreply.github.com>

Author: 3 people

docs/configuration/configuration.rst

@@ -1208,6 +1208,25 @@ from the :ref:`remote.name <config-remote-name>` location of your git repository
 
 ----
 
+.. _config-repo_dir:
+
+``repo_dir``
+""""""""""""
+
+**Type:** ``str``
+
+Specify the directory of the Git repository. This is used to determine the location of
+the repository for various operations, such as creating tags and commits. PSR will attempt
+to automatically determine the location of the repository in parent directories of the
+current working directory but will emit a warning if it is higher than this defined value.
+
+If a git repository is not found from this location or any parent directories, PSR will
+raise an error and exit.
+
+**Default:** ``"."``
+
+----
+
 .. _config-tag_format:
 
 ``tag_format``

src/semantic_release/cli/config.py

@@ -13,7 +13,18 @@
     error as RegExpError,  # noqa: N812
     escape as regex_escape,
 )
-from typing import Any, ClassVar, Dict, List, Literal, Optional, Tuple, Type, Union
+from typing import (
+    Any,
+    ClassVar,
+    Dict,
+    List,
+    Literal,
+    Optional,
+    Tuple,
+    Type,
+    Union,
+    cast,
+)
 
 # typing_extensions is for Python 3.8, 3.9, 3.10 compatibility
 import tomlkit
@@ -363,7 +374,7 @@ class RawConfig(BaseModel):
     logging_use_named_masks: bool = False
     major_on_zero: bool = True
     allow_zero_version: bool = False
-    repo_dir: Annotated[Path, Field(validate_default=True)] = Path(".")
+    repo_dir: Path = Field(default=cast("Path", "."), validate_default=True)
     remote: RemoteConfig = RemoteConfig()
     no_git_verify: bool = False
     tag_format: str = "v{version}"
@@ -388,18 +399,19 @@ def verify_git_repo_dir(cls, dir_path: Path) -> Path:
                 found_path = (
                     Path(git_repo.working_tree_dir or git_repo.working_dir)
                     .expanduser()
+                    .resolve()
                     .absolute()
                 )
 
         except InvalidGitRepositoryError as err:
-            raise InvalidGitRepositoryError("No valid git repository found!") from err
+            msg = "No valid git repository found!"
+            raise InvalidGitRepositoryError(msg) from err
 
-        if dir_path.absolute() != found_path:
-            logging.warning(
-                "Found .git/ in higher parent directory rather than provided in configuration."
-            )
+        if dir_path.resolve().absolute() != found_path:
+            msg = "Found .git/ in higher parent directory rather than provided in configuration."
+            logger.warning(msg)
 
-        return found_path.resolve()
+        return found_path
 
     @field_validator("commit_parser", mode="after")
     @classmethod

tests/e2e/cmd_version/bump_version/git_flow/test_repo_1_channel.py

@@ -10,7 +10,7 @@
     repo_w_git_flow_emoji_commits,
     repo_w_git_flow_scipy_commits,
 )
-from tests.util import temporary_working_directory
+from tests.util import assert_str_not_in_output, temporary_working_directory
 
 if TYPE_CHECKING:
     from pathlib import Path
@@ -66,6 +66,7 @@ def test_gitflow_repo_rebuild_1_channel(
     pyproject_toml_file: Path,
     changelog_md_file: Path,
     changelog_rst_file: Path,
+    caplog: pytest.LogCaptureFixture,
 ):
     # build target repo into a temporary directory
     target_repo_dir = example_project_dir / repo_fixture_name
@@ -153,6 +154,8 @@ def test_gitflow_repo_rebuild_1_channel(
 
         # Evaluate (normal release actions should have occurred as expected)
         # ------------------------------------------------------------------
+        # The warning should not be present in the logs since we are running in the same directory as the .git repo
+        assert_str_not_in_output("Found .git/ in higher parent directory", caplog.text)
         # Make sure version file is updated
         assert expected_pyproject_toml_content == actual_pyproject_toml_content
         assert expected_version_file_content == actual_version_file_content

tests/e2e/cmd_version/bump_version/git_flow/test_repo_2_channels.py

@@ -10,7 +10,7 @@
     repo_w_git_flow_w_alpha_prereleases_n_emoji_commits,
     repo_w_git_flow_w_alpha_prereleases_n_scipy_commits,
 )
-from tests.util import temporary_working_directory
+from tests.util import assert_str_not_in_output, temporary_working_directory
 
 if TYPE_CHECKING:
     from pathlib import Path
@@ -66,6 +66,7 @@ def test_gitflow_repo_rebuild_2_channels(
     pyproject_toml_file: Path,
     changelog_md_file: Path,
     changelog_rst_file: Path,
+    caplog: pytest.LogCaptureFixture,
 ):
     # build target repo into a temporary directory
     target_repo_dir = example_project_dir / repo_fixture_name
@@ -153,6 +154,8 @@ def test_gitflow_repo_rebuild_2_channels(
 
         # Evaluate (normal release actions should have occurred as expected)
         # ------------------------------------------------------------------
+        # The warning should not be present in the logs since we are running in the same directory as the .git repo
+        assert_str_not_in_output("Found .git/ in higher parent directory", caplog.text)
         # Make sure version file is updated
         assert expected_pyproject_toml_content == actual_pyproject_toml_content
         assert expected_version_file_content == actual_version_file_content

tests/e2e/cmd_version/bump_version/git_flow/test_repo_3_channels.py

@@ -11,7 +11,7 @@
     repo_w_git_flow_w_rc_n_alpha_prereleases_n_emoji_commits,
     repo_w_git_flow_w_rc_n_alpha_prereleases_n_scipy_commits,
 )
-from tests.util import temporary_working_directory
+from tests.util import assert_str_not_in_output, temporary_working_directory
 
 if TYPE_CHECKING:
     from pathlib import Path
@@ -68,6 +68,7 @@ def test_gitflow_repo_rebuild_3_channels(
     pyproject_toml_file: Path,
     changelog_md_file: Path,
     changelog_rst_file: Path,
+    caplog: pytest.LogCaptureFixture,
 ):
     # build target repo into a temporary directory
     target_repo_dir = example_project_dir / repo_fixture_name
@@ -154,6 +155,8 @@ def test_gitflow_repo_rebuild_3_channels(
 
         # Evaluate (normal release actions should have occurred as expected)
         # ------------------------------------------------------------------
+        # The warning should not be present in the logs since we are running in the same directory as the .git repo
+        assert_str_not_in_output("Found .git/ in higher parent directory", caplog.text)
         # Make sure version file is updated
         assert expected_pyproject_toml_content == actual_pyproject_toml_content
         assert expected_version_file_content == actual_version_file_content

tests/e2e/cmd_version/bump_version/git_flow/test_repo_4_channels.py

@@ -10,7 +10,7 @@
     repo_w_git_flow_w_beta_alpha_rev_prereleases_n_emoji_commits,
     repo_w_git_flow_w_beta_alpha_rev_prereleases_n_scipy_commits,
 )
-from tests.util import temporary_working_directory
+from tests.util import assert_str_not_in_output, temporary_working_directory
 
 if TYPE_CHECKING:
     from pathlib import Path
@@ -66,6 +66,7 @@ def test_gitflow_repo_rebuild_4_channels(
     pyproject_toml_file: Path,
     changelog_md_file: Path,
     changelog_rst_file: Path,
+    caplog: pytest.LogCaptureFixture,
 ):
     # build target repo into a temporary directory
     target_repo_dir = example_project_dir / repo_fixture_name
@@ -153,6 +154,8 @@ def test_gitflow_repo_rebuild_4_channels(
 
         # Evaluate (normal release actions should have occurred as expected)
         # ------------------------------------------------------------------
+        # The warning should not be present in the logs since we are running in the same directory as the .git repo
+        assert_str_not_in_output("Found .git/ in higher parent directory", caplog.text)
         # Make sure version file is updated
         assert expected_pyproject_toml_content == actual_pyproject_toml_content
         assert expected_version_file_content == actual_version_file_content

tests/e2e/cmd_version/bump_version/github_flow/test_repo_1_channel.py

@@ -10,7 +10,7 @@
     repo_w_github_flow_w_default_release_channel_emoji_commits,
     repo_w_github_flow_w_default_release_channel_scipy_commits,
 )
-from tests.util import temporary_working_directory
+from tests.util import assert_str_not_in_output, temporary_working_directory
 
 if TYPE_CHECKING:
     from pathlib import Path
@@ -66,6 +66,7 @@ def test_githubflow_repo_rebuild_1_channel(
     pyproject_toml_file: Path,
     changelog_md_file: Path,
     changelog_rst_file: Path,
+    caplog: pytest.LogCaptureFixture,
 ):
     # build target repo into a temporary directory
     target_repo_dir = example_project_dir / repo_fixture_name
@@ -153,6 +154,8 @@ def test_githubflow_repo_rebuild_1_channel(
 
         # Evaluate (normal release actions should have occurred as expected)
         # ------------------------------------------------------------------
+        # The warning should not be present in the logs since we are running in the same directory as the .git repo
+        assert_str_not_in_output("Found .git/ in higher parent directory", caplog.text)
         # Make sure version file is updated
         assert expected_pyproject_toml_content == actual_pyproject_toml_content
         assert expected_version_file_content == actual_version_file_content

tests/e2e/cmd_version/bump_version/github_flow/test_repo_1_channel_branch_update_merge.py

@@ -13,7 +13,7 @@
     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
+from tests.util import assert_str_not_in_output, temporary_working_directory
 
 if TYPE_CHECKING:
     from pathlib import Path
@@ -72,6 +72,7 @@ def test_github_flow_repo_w_default_release_n_branch_update_merge(
     pyproject_toml_file: Path,
     changelog_md_file: Path,
     changelog_rst_file: Path,
+    caplog: pytest.LogCaptureFixture,
 ):
     # build target repo into a temporary directory
     target_repo_dir = example_project_dir / repo_fixture_name
@@ -166,6 +167,8 @@ def test_github_flow_repo_w_default_release_n_branch_update_merge(
 
         # Evaluate (normal release actions should have occurred as expected)
         # ------------------------------------------------------------------
+        # The warning should not be present in the logs since we are running in the same directory as the .git repo
+        assert_str_not_in_output("Found .git/ in higher parent directory", caplog.text)
         # Make sure version file is updated
         assert expected_pyproject_toml_content == actual_pyproject_toml_content
         assert expected_version_file_content == actual_version_file_content

tests/e2e/cmd_version/bump_version/github_flow/test_repo_2_channels.py

@@ -10,7 +10,7 @@
     repo_w_github_flow_w_feature_release_channel_emoji_commits,
     repo_w_github_flow_w_feature_release_channel_scipy_commits,
 )
-from tests.util import temporary_working_directory
+from tests.util import assert_str_not_in_output, temporary_working_directory
 
 if TYPE_CHECKING:
     from pathlib import Path
@@ -66,6 +66,7 @@ def test_githubflow_repo_rebuild_2_channels(
     pyproject_toml_file: Path,
     changelog_md_file: Path,
     changelog_rst_file: Path,
+    caplog: pytest.LogCaptureFixture,
 ):
     # build target repo into a temporary directory
     target_repo_dir = example_project_dir / repo_fixture_name
@@ -153,6 +154,8 @@ def test_githubflow_repo_rebuild_2_channels(
 
         # Evaluate (normal release actions should have occurred as expected)
         # ------------------------------------------------------------------
+        # The warning should not be present in the logs since we are running in the same directory as the .git repo
+        assert_str_not_in_output("Found .git/ in higher parent directory", caplog.text)
         # Make sure version file is updated
         assert expected_pyproject_toml_content == actual_pyproject_toml_content
         assert expected_version_file_content == actual_version_file_content

tests/e2e/cmd_version/bump_version/github_flow_monorepo/test_monorepo_1_channel.py

@@ -12,7 +12,7 @@
 from tests.fixtures.monorepos.github_flow import (
     monorepo_w_github_flow_w_default_release_channel_conventional_commits,
 )
-from tests.util import temporary_working_directory
+from tests.util import assert_str_not_in_output, temporary_working_directory
 
 if TYPE_CHECKING:
     from typing import Literal, Sequence
@@ -71,6 +71,7 @@ def test_githubflow_monorepo_rebuild_1_channel(
     monorepo_pkg2_changelog_md_file: Path,
     monorepo_pkg1_changelog_rst_file: Path,
     monorepo_pkg2_changelog_rst_file: Path,
+    caplog: pytest.LogCaptureFixture,
 ):
     # build target repo into a temporary directory
     target_repo_dir = example_project_dir / repo_fixture_name
@@ -225,6 +226,10 @@ def test_githubflow_monorepo_rebuild_1_channel(
 
         # Evaluate (normal release actions should have occurred as expected)
         # ------------------------------------------------------------------
+        # The warning should not be present in the logs since we have configured repo_dir
+        # to be the parent directory from where PSR is being run, so although it is in the
+        # parent directory, it is known to the user and should not be a warning
+        assert_str_not_in_output("Found .git/ in higher parent directory", caplog.text)
         # Make sure version file is updated
         assert (
             expected_pkg1_pyproject_toml_content == actual_pkg1_pyproject_toml_content