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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-semantic-release
-Version: 10.5.2
+Version: 10.5.3
 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.2 → python_semantic_release-10.5.3}/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.2
+            uses: python-semantic-release/python-semantic-release@v10.5.3
             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.2
+            uses: python-semantic-release/publish-action@v10.5.3
             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.2
+    uses: python-semantic-release/python-semantic-release@v10.5.3
     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.2
+          uses: python-semantic-release/python-semantic-release@v10.5.3
           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.2
+          uses: python-semantic-release/python-semantic-release@v10.5.3
           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.2
+          uses: python-semantic-release/publish-action@v10.5.3
           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.2
+          uses: python-semantic-release/publish-action@v10.5.3
           if: steps.release-submod-2.outputs.released == 'true'
           with:
             directory: ${{ env.SUBMODULE_2_DIR }}

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

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-semantic-release"
-version = "10.5.2"
+version = "10.5.3"
 description = "Automatic Semantic Versioning for Python projects"
 requires-python = "~= 3.8"
 license = { text = "MIT" }
@@ -409,6 +409,7 @@ sections = { "tests" = ["tests"] }
 ignore_names = ["change_to_ex_proj_dir", "init_example_project"]
 
 [tool.semantic_release]
+add_partial_tags = true
 logging_use_named_masks = true
 commit_parser = "conventional"
 commit_parser_options = { parse_squash_commits = true, ignore_merge_commits = true }

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

@@ -753,6 +753,7 @@ def version(  # noqa: C901
                 project.verify_upstream_unchanged(
                     local_ref="HEAD~1",
                     upstream_ref=config.remote.name,
+                    remote_url=remote_url,
                     noop=opts.noop,
                 )
             except UpstreamBranchChangedError as exc:

{python_semantic_release-10.5.2 → python_semantic_release-10.5.3}/src/semantic_release/commit_parser/conventional/options_monorepo.py

@@ -43,37 +43,46 @@ class ConventionalCommitMonorepoParserOptions(ConventionalCommitParserOptions):
     to match them literally.
     """
 
-    @classmethod
     @field_validator("path_filters", mode="before")
-    def convert_strs_to_paths(cls, value: Any) -> tuple[Path, ...]:
-        values = value if isinstance(value, Iterable) else [value]
-        results: list[Path] = []
+    @classmethod
+    def convert_strs_to_paths(cls, value: Any) -> tuple[str, ...]:
+        if isinstance(value, str):
+            return (value,)
 
-        for val in values:
-            if isinstance(val, (str, Path)):
-                results.append(Path(val))
-                continue
+        if isinstance(value, Path):
+            return (str(value),)
 
-            raise TypeError(f"Invalid type: {type(val)}, expected str or Path.")
+        if isinstance(value, Iterable):
+            results: list[str] = []
+            for val in value:
+                if isinstance(val, (str, Path)):
+                    results.append(str(Path(val)))
+                    continue
 
-        return tuple(results)
+                msg = f"Invalid type: {type(val)}, expected str or Path."
+                raise TypeError(msg)
+
+            return tuple(results)
+
+        msg = f"Invalid type: {type(value)}, expected str, Path, or Iterable."
+        raise TypeError(msg)
 
-    @classmethod
     @field_validator("path_filters", mode="after")
-    def resolve_path(cls, dir_paths: tuple[Path, ...]) -> tuple[Path, ...]:
+    @classmethod
+    def resolve_path(cls, dir_path_strs: tuple[str, ...]) -> tuple[str, ...]:
         return tuple(
             (
-                Path(f"!{Path(str_path[1:]).expanduser().absolute().resolve()}")
+                f"!{Path(str_path[1:]).expanduser().absolute().resolve()}"
                 # maintains the negation prefix if it exists
-                if (str_path := str(path)).startswith("!")
+                if str_path.startswith("!")
                 # otherwise, resolve the path normally
-                else path.expanduser().absolute().resolve()
+                else str(Path(str_path).expanduser().absolute().resolve())
             )
-            for path in dir_paths
+            for str_path in dir_path_strs
         )
 
-    @classmethod
     @field_validator("scope_prefix", mode="after")
+    @classmethod
     def validate_scope_prefix(cls, scope_prefix: str) -> str:
         if not scope_prefix:
             return ""

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

@@ -336,13 +336,18 @@ class GitProject:
                 raise GitPushError(f"Failed to push tag ({tag}) to remote") from err
 
     def verify_upstream_unchanged(  # noqa: C901
-        self, local_ref: str = "HEAD", upstream_ref: str = "origin", noop: bool = False
+        self,
+        local_ref: str = "HEAD",
+        upstream_ref: str = "origin",
+        remote_url: str | None = None,
+        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 remote_url: Optional authenticated remote URL to use for fetching (default: None, uses configured remote)
         :param noop: Whether to skip the actual verification (for dry-run mode)
 
         :raises UpstreamBranchChangedError: If the upstream branch has changed
@@ -409,7 +414,46 @@ class GitProject:
             # Fetch the latest changes from the remote
             self.logger.info("Fetching latest changes from remote '%s'", remote_name)
             try:
-                remote_ref_obj.fetch()
+                # Check if we should use authenticated URL for fetch
+                # Only use remote_url if:
+                # 1. It's provided and different from the configured remote URL
+                # 2. It contains authentication credentials (@ symbol)
+                # 3. The configured remote is NOT a local path, file:// URL, or test URL (example.com)
+                #    This ensures we don't break tests or local development
+                configured_url = remote_ref_obj.url
+                is_local_or_test_remote = (
+                    configured_url.startswith(("file://", "/", "C:/", "H:/"))
+                    or "example.com" in configured_url
+                    or not configured_url.startswith(
+                        (
+                            "https://",
+                            "http://",
+                            "git://",
+                            "git@",
+                            "ssh://",
+                            "git+ssh://",
+                        )
+                    )
+                )
+
+                use_authenticated_fetch = (
+                    remote_url
+                    and "@" in remote_url
+                    and remote_url != configured_url
+                    and not is_local_or_test_remote
+                )
+
+                if use_authenticated_fetch:
+                    # Use authenticated remote URL for fetch
+                    # Fetch the remote branch and update the local tracking ref
+                    repo.git.fetch(
+                        remote_url,
+                        f"refs/heads/{remote_branch_name}:refs/remotes/{upstream_full_ref_name}",
+                    )
+                else:
+                    # Use the default remote configuration for local paths,
+                    # file:// URLs, test URLs, or when no authentication is needed
+                    remote_ref_obj.fetch()
             except GitCommandError as err:
                 self.logger.exception(str(err))
                 err_msg = f"Failed to fetch from remote '{remote_name}'"

{python_semantic_release-10.5.2 → python_semantic_release-10.5.3}/tests/fixtures/git_repo.py

@@ -142,6 +142,7 @@ if TYPE_CHECKING:
         sha: str
         datetime: NotRequired[DatetimeISOStr]
         include_in_changelog: bool
+        file_to_change: NotRequired[Path | str]
 
     class BaseRepoVersionDef(TypedDict):
         """A Common Repo definition for a get_commits_repo_*() fixture with all commit convention types"""
@@ -290,6 +291,7 @@ if TYPE_CHECKING:
         scipy: str
         datetime: NotRequired[DatetimeISOStr]
         include_in_changelog: NotRequired[bool]
+        file_to_change: NotRequired[Path | str]
 
     class DetailsBase(TypedDict):
         pre_actions: NotRequired[Sequence[RepoActions]]
@@ -1127,7 +1129,9 @@ def simulate_change_commits_n_rtn_changelog_entry(
         changelog_entries: list[CommitDef] = []
         for commit_msg in commit_msgs:
             if not git_repo.is_dirty(index=True, working_tree=False):
-                add_text_to_file(git_repo, file_in_repo)
+                add_text_to_file(
+                    git_repo, str(commit_msg.get("file_to_change", file_in_repo))
+                )
 
             changelog_entries.append(commit_n_rtn_changelog_entry(git_repo, commit_msg))
 
@@ -1336,39 +1340,6 @@ def configure_base_repo(  # noqa: C901
 
 @pytest.fixture(scope="session")
 def separate_squashed_commit_def() -> SeparateSquashedCommitDefFn:
-    # default_conventional_parser: ConventionalCommitParser,
-    # default_emoji_parser: EmojiCommitParser,
-    # default_scipy_parser: ScipyCommitParser,
-    # message_parsers: dict[
-    #     CommitConvention,
-    #     ConventionalCommitParser | EmojiCommitParser | ScipyCommitParser,
-    # ] = {
-    #     "conventional": ConventionalCommitParser(
-    #         options=ConventionalCommitParserOptions(
-    #             **{
-    #                 **default_conventional_parser.options.__dict__,
-    #                 "parse_squash_commits": True,
-    #             }
-    #         )
-    #     ),
-    #     "emoji": EmojiCommitParser(
-    #         options=EmojiParserOptions(
-    #             **{
-    #                 **default_emoji_parser.options.__dict__,
-    #                 "parse_squash_commits": True,
-    #             }
-    #         )
-    #     ),
-    #     "scipy": ScipyCommitParser(
-    #         options=ScipyParserOptions(
-    #             **{
-    #                 **default_scipy_parser.options.__dict__,
-    #                 "parse_squash_commits": True,
-    #             }
-    #         )
-    #     ),
-    # }
-
     def _separate_squashed_commit_def(
         squashed_commit_def: CommitDef,
         parser: SquashedCommitSupportedParser,
@@ -1435,7 +1406,7 @@ def convert_commit_spec_to_commit_def(
         )
 
         # Extract the correct commit message for the commit type
-        return {
+        commit_def: CommitDef = {
             **parse_msg_fn(commit_spec[commit_type], parser=parser),
             "cid": commit_spec["cid"],
             "datetime": (
@@ -1443,9 +1414,18 @@ def convert_commit_spec_to_commit_def(
                 if "datetime" in commit_spec
                 else stable_now_date.isoformat(timespec="seconds")
             ),
-            "include_in_changelog": (commit_spec.get("include_in_changelog", True)),
+            "include_in_changelog": commit_spec.get("include_in_changelog", True),
         }
 
+        if "file_to_change" in commit_spec:
+            commit_def.update(
+                {
+                    "file_to_change": commit_spec["file_to_change"],
+                }
+            )
+
+        return commit_def
+
     return _convert
 
 

{python_semantic_release-10.5.2 → python_semantic_release-10.5.3}/tests/fixtures/monorepos/example_monorepo.py

@@ -68,8 +68,12 @@ def build_spec_hash_4_example_monorepo(
 @pytest.fixture(scope="session")
 def cached_example_monorepo(
     build_repo_or_copy_cache: BuildRepoOrCopyCacheFn,
-    monorepo_pkg1_dir: Path,
-    monorepo_pkg2_dir: Path,
+    monorepo_pkg1_name: str,
+    monorepo_pkg2_name: str,
+    monorepo_pkg1_dir: str,
+    monorepo_pkg2_dir: str,
+    monorepo_pkg1_docs_dir: str,
+    monorepo_pkg2_docs_dir: str,
     monorepo_pkg1_version_py_file: Path,
     monorepo_pkg2_version_py_file: Path,
     monorepo_pkg1_pyproject_toml_file: Path,
@@ -104,6 +108,13 @@ def cached_example_monorepo(
                 print("{pkg_name} Hello World")
             '''
         ).lstrip()
+        doc_index_contents = dedent(
+            """
+            ==================
+            {pkg_name} Documentation
+            ==================
+            """
+        ).lstrip()
 
         with temporary_working_directory(cached_project_path):
             update_version_py_file(
@@ -127,6 +138,14 @@ def cached_example_monorepo(
             (".gitignore", gitignore_contents),
             (monorepo_pkg1_pyproject_toml_file, EXAMPLE_PYPROJECT_TOML_CONTENT),
             (monorepo_pkg2_pyproject_toml_file, EXAMPLE_PYPROJECT_TOML_CONTENT),
+            (
+                Path(monorepo_pkg1_docs_dir, "index.rst"),
+                doc_index_contents.format(pkg_name=monorepo_pkg1_name),
+            ),
+            (
+                Path(monorepo_pkg2_docs_dir, "index.rst"),
+                doc_index_contents.format(pkg_name=monorepo_pkg2_name),
+            ),
         ]
 
         for file, contents in file_2_contents:
@@ -216,6 +235,27 @@ def monorepo_pkg2_name() -> str:
     return "pkg2"
 
 
+@pytest.fixture(scope="session")
+def monorepo_pkg_docs_dir_pattern() -> str:
+    return str(Path("docs", "source", "{package_name}"))
+
+
+@pytest.fixture(scope="session")
+def monorepo_pkg1_docs_dir(
+    monorepo_pkg1_name: str,
+    monorepo_pkg_docs_dir_pattern: str,
+) -> str:
+    return monorepo_pkg_docs_dir_pattern.format(package_name=monorepo_pkg1_name)
+
+
+@pytest.fixture(scope="session")
+def monorepo_pkg2_docs_dir(
+    monorepo_pkg2_name: str,
+    monorepo_pkg_docs_dir_pattern: str,
+) -> str:
+    return monorepo_pkg_docs_dir_pattern.format(package_name=monorepo_pkg2_name)
+
+
 @pytest.fixture(scope="session")
 def monorepo_pkg_dir_pattern() -> str:
     return str(Path("packages", "{package_name}"))

{python_semantic_release-10.5.2 → python_semantic_release-10.5.3}/tests/fixtures/monorepos/github_flow/monorepo_w_default_release.py

@@ -96,8 +96,10 @@ def get_repo_definition_4_github_flow_monorepo_w_default_release_channel(
     monorepo_pkg2_changelog_rst_file: Path,
     monorepo_pkg1_name: str,
     monorepo_pkg2_name: str,
-    monorepo_pkg1_dir: Path,
-    monorepo_pkg2_dir: Path,
+    monorepo_pkg1_dir: str,
+    monorepo_pkg2_dir: str,
+    monorepo_pkg1_docs_dir: str,
+    monorepo_pkg2_docs_dir: str,
     monorepo_pkg1_version_py_file: Path,
     monorepo_pkg2_version_py_file: Path,
     monorepo_pkg1_pyproject_toml_file: Path,
@@ -117,7 +119,8 @@ def get_repo_definition_4_github_flow_monorepo_w_default_release_channel(
     * chore(release): pkg1@1.1.0 [skip ci] (tag: pkg1-v1.1.0, branch: main, HEAD -> main)
     * feat(pkg1): file modified outside of pkg 1, identified by scope (#5)
     |
-    | * feat(pkg1): file modified outside of pkg 1, identified by scope (branch: pkg1/feat/pr-4)
+    | * docs: pkg1 docs modified outside of pkg 1, identified by path filter (branch: pkg1/feat/pr-4)
+    | * feat(pkg1): file modified outside of pkg 1, identified by scope
     |/
     * chore(release): pkg2@1.1.1 [skip ci] (tag: pkg2-v1.1.1)
     * fix(pkg2-cli): file modified outside of pkg 2, identified by scope (#4)
@@ -207,21 +210,23 @@ def get_repo_definition_4_github_flow_monorepo_w_default_release_channel(
         if commit_type != "conventional":
             raise ValueError(f"Unsupported commit type: {commit_type}")
 
+        pkg1_path_filters = (".", f"../../{monorepo_pkg1_docs_dir}")
         pkg1_commit_parser = ConventionalCommitMonorepoParser(
             options=ConventionalCommitMonorepoParserOptions(
                 parse_squash_commits=True,
                 ignore_merge_commits=ignore_merge_commits,
                 scope_prefix=f"{monorepo_pkg1_name}-?",
-                path_filters=(".",),
+                path_filters=pkg1_path_filters,
             )
         )
 
+        pkg2_path_filters = (".", f"../../{monorepo_pkg2_docs_dir}")
         pkg2_commit_parser = ConventionalCommitMonorepoParser(
             options=ConventionalCommitMonorepoParserOptions(
                 parse_squash_commits=pkg1_commit_parser.options.parse_squash_commits,
                 ignore_merge_commits=pkg1_commit_parser.options.ignore_merge_commits,
                 scope_prefix=f"{monorepo_pkg2_name}-?",
-                path_filters=(".",),
+                path_filters=pkg2_path_filters,
             )
         )
 
@@ -277,7 +282,7 @@ def get_repo_definition_4_github_flow_monorepo_w_default_release_channel(
                                         )
                                     ),
                                     "tool.semantic_release.commit_parser_options.scope_prefix": pkg1_commit_parser.options.scope_prefix,
-                                    "tool.semantic_release.commit_parser_options.path_filters": pkg1_commit_parser.options.path_filters,
+                                    "tool.semantic_release.commit_parser_options.path_filters": pkg1_path_filters,
                                     **(extra_configs or {}),
                                 },
                             },
@@ -301,7 +306,7 @@ def get_repo_definition_4_github_flow_monorepo_w_default_release_channel(
                                         )
                                     ),
                                     "tool.semantic_release.commit_parser_options.scope_prefix": pkg2_commit_parser.options.scope_prefix,
-                                    "tool.semantic_release.commit_parser_options.path_filters": pkg2_commit_parser.options.path_filters,
+                                    "tool.semantic_release.commit_parser_options.path_filters": pkg2_path_filters,
                                     **(extra_configs or {}),
                                 },
                             },
@@ -774,7 +779,15 @@ def get_repo_definition_4_github_flow_monorepo_w_default_release_channel(
                 "emoji": ":sparkles: (pkg1) file modified outside of pkg 1, identified by scope",
                 "scipy": "ENH:pkg1: file modified outside of pkg 1, identified by scope",
                 "datetime": next(commit_timestamp_gen),
-            }
+            },
+            {
+                "cid": "pkg1-docs-2-squashed",
+                "conventional": "docs: pkg1 docs modified outside of pkg 1, identified by path filter",
+                "emoji": ":book: pkg1 docs modified outside of pkg 1, identified by path filter",
+                "scipy": "DOC: pkg1 docs modified outside of pkg 1, identified by path filter",
+                "datetime": next(commit_timestamp_gen),
+                "file_to_change": f"{monorepo_pkg1_docs_dir}/index.rst",
+            },
         ]
 
         repo_construction_steps.extend(

{python_semantic_release-10.5.2 → python_semantic_release-10.5.3}/tests/fixtures/monorepos/github_flow/monorepo_w_release_channels.py

@@ -97,8 +97,10 @@ def get_repo_definition_4_github_flow_monorepo_w_feature_release_channel(
     monorepo_pkg2_changelog_rst_file: Path,
     monorepo_pkg1_name: str,
     monorepo_pkg2_name: str,
-    monorepo_pkg1_dir: Path,
-    monorepo_pkg2_dir: Path,
+    monorepo_pkg1_dir: str,
+    monorepo_pkg2_dir: str,
+    monorepo_pkg1_docs_dir: str,
+    monorepo_pkg2_docs_dir: str,
     monorepo_pkg1_version_py_file: Path,
     monorepo_pkg2_version_py_file: Path,
     stable_now_date: GetStableDateNowFn,
@@ -119,7 +121,7 @@ def get_repo_definition_4_github_flow_monorepo_w_feature_release_channel(
     | * chore(release): pkg2@1.1.0-alpha.2 [skip ci] (tag: pkg2-v1.1.0-alpha.2, branch: pkg2/feat/pr-2)
     | * fix(pkg2-cli): file modified outside of pkg 2, identified by scope
     | * chore(release): pkg2@1.1.0-alpha.1 [skip ci] (tag: pkg2-v1.1.0-alpha.1)
-    | * docs: add cli documentation
+    | * docs: pkg2 docs modified outside of pkg 2, identified by path filter
     | * test: add cli tests
     | * feat: no pkg scope but file in pkg 2 directory
     |/
@@ -203,21 +205,23 @@ def get_repo_definition_4_github_flow_monorepo_w_feature_release_channel(
         if commit_type != "conventional":
             raise ValueError(f"Unsupported commit type: {commit_type}")
 
+        pkg1_path_filters = (".", f"../../{monorepo_pkg1_docs_dir}")
         pkg1_commit_parser = ConventionalCommitMonorepoParser(
             options=ConventionalCommitMonorepoParserOptions(
                 parse_squash_commits=True,
                 ignore_merge_commits=ignore_merge_commits,
                 scope_prefix=f"{monorepo_pkg1_name}-?",
-                path_filters=(".",),
+                path_filters=pkg1_path_filters,
             )
         )
 
+        pkg2_path_filters = (".", f"../../{monorepo_pkg2_docs_dir}")
         pkg2_commit_parser = ConventionalCommitMonorepoParser(
             options=ConventionalCommitMonorepoParserOptions(
                 parse_squash_commits=pkg1_commit_parser.options.parse_squash_commits,
                 ignore_merge_commits=pkg1_commit_parser.options.ignore_merge_commits,
                 scope_prefix=f"{monorepo_pkg2_name}-?",
-                path_filters=(".",),
+                path_filters=pkg2_path_filters,
             )
         )
 
@@ -277,7 +281,7 @@ def get_repo_definition_4_github_flow_monorepo_w_feature_release_channel(
                                         "prerelease_token": "alpha",
                                     },
                                     "tool.semantic_release.commit_parser_options.scope_prefix": pkg1_commit_parser.options.scope_prefix,
-                                    "tool.semantic_release.commit_parser_options.path_filters": pkg1_commit_parser.options.path_filters,
+                                    "tool.semantic_release.commit_parser_options.path_filters": pkg1_path_filters,
                                     **(extra_configs or {}),
                                 },
                             },
@@ -307,7 +311,7 @@ def get_repo_definition_4_github_flow_monorepo_w_feature_release_channel(
                                         "prerelease_token": "alpha",
                                     },
                                     "tool.semantic_release.commit_parser_options.scope_prefix": pkg2_commit_parser.options.scope_prefix,
-                                    "tool.semantic_release.commit_parser_options.path_filters": pkg2_commit_parser.options.path_filters,
+                                    "tool.semantic_release.commit_parser_options.path_filters": pkg2_path_filters,
                                     **(extra_configs or {}),
                                 },
                             },
@@ -646,11 +650,12 @@ def get_repo_definition_4_github_flow_monorepo_w_feature_release_channel(
                                         cid_pkg2_feb1_c3_docs
                                         := "pkg2_feat_branch_1_c3_docs"
                                     ),
-                                    "conventional": "docs: add cli documentation",
-                                    "emoji": ":memo: add cli documentation",
-                                    "scipy": "DOC: add cli documentation",
+                                    "conventional": "docs: pkg2 docs modified outside of pkg 2, identified by path filter",
+                                    "emoji": ":book: pkg2 docs modified outside of pkg 2, identified by path filter",
+                                    "scipy": "DOC: pkg2 docs modified outside of pkg 2, identified by path filter",
                                     "datetime": next(commit_timestamp_gen),
                                     "include_in_changelog": True,
+                                    "file_to_change": f"../../{monorepo_pkg2_docs_dir}/index.rst",
                                 },
                             ],
                             commit_type,

{python_semantic_release-10.5.2 → python_semantic_release-10.5.3}/tests/fixtures/monorepos/trunk_based_dev/monorepo_w_tags.py

@@ -88,8 +88,10 @@ def get_repo_definition_4_trunk_only_monorepo_w_tags(
     monorepo_pkg2_changelog_rst_file: Path,
     monorepo_pkg1_name: str,
     monorepo_pkg2_name: str,
-    monorepo_pkg1_dir: Path,
-    monorepo_pkg2_dir: Path,
+    monorepo_pkg1_dir: str,
+    monorepo_pkg2_dir: str,
+    monorepo_pkg1_docs_dir: str,
+    monorepo_pkg2_docs_dir: str,
     monorepo_pkg1_version_py_file: Path,
     monorepo_pkg2_version_py_file: Path,
     stable_now_date: GetStableDateNowFn,
@@ -104,6 +106,7 @@ def get_repo_definition_4_trunk_only_monorepo_w_tags(
 
     ```
     * chore(release): pkg1@0.1.0 [skip ci] (tag: pkg1-v0.1.0, branch: main)
+    * docs: pkg1 docs modified outside of pkg 1, identified by path filter
     * feat(pkg1): file modified outside of pkg 1, identified by scope
     * chore(release): pkg2@0.1.1 [skip ci] (tag: pkg2-v0.1.1)
     * fix(pkg2-cli): file modified outside of pkg 2, identified by scope
@@ -182,21 +185,23 @@ def get_repo_definition_4_trunk_only_monorepo_w_tags(
         if commit_type != "conventional":
             raise ValueError(f"Unsupported commit type: {commit_type}")
 
+        pkg1_path_filters = (".", f"../../{monorepo_pkg1_docs_dir}")
         pkg1_commit_parser = ConventionalCommitMonorepoParser(
             options=ConventionalCommitMonorepoParserOptions(
                 parse_squash_commits=True,
                 ignore_merge_commits=ignore_merge_commits,
                 scope_prefix=f"{monorepo_pkg1_name}-?",
-                path_filters=(".",),
+                path_filters=pkg1_path_filters,
             )
         )
 
+        pkg2_path_filters = (".", f"../../{monorepo_pkg2_docs_dir}")
         pkg2_commit_parser = ConventionalCommitMonorepoParser(
             options=ConventionalCommitMonorepoParserOptions(
                 parse_squash_commits=pkg1_commit_parser.options.parse_squash_commits,
                 ignore_merge_commits=pkg1_commit_parser.options.ignore_merge_commits,
                 scope_prefix=f"{monorepo_pkg2_name}-?",
-                path_filters=(".",),
+                path_filters=pkg2_path_filters,
             )
         )
 
@@ -247,7 +252,7 @@ def get_repo_definition_4_trunk_only_monorepo_w_tags(
                                         )
                                     ),
                                     "tool.semantic_release.commit_parser_options.scope_prefix": pkg1_commit_parser.options.scope_prefix,
-                                    "tool.semantic_release.commit_parser_options.path_filters": pkg1_commit_parser.options.path_filters,
+                                    "tool.semantic_release.commit_parser_options.path_filters": pkg1_path_filters,
                                     **(extra_configs or {}),
                                 },
                             },
@@ -271,7 +276,7 @@ def get_repo_definition_4_trunk_only_monorepo_w_tags(
                                         )
                                     ),
                                     "tool.semantic_release.commit_parser_options.scope_prefix": pkg2_commit_parser.options.scope_prefix,
-                                    "tool.semantic_release.commit_parser_options.path_filters": pkg2_commit_parser.options.path_filters,
+                                    "tool.semantic_release.commit_parser_options.path_filters": pkg2_path_filters,
                                     **(extra_configs or {}),
                                 },
                             },
@@ -524,6 +529,14 @@ def get_repo_definition_4_trunk_only_monorepo_w_tags(
                                     "scipy": "ENH:pkg1: file modified outside of pkg 1, identified by scope",
                                     "datetime": next(commit_timestamp_gen),
                                 },
+                                {
+                                    "cid": (cid_c11_pkg1_docs := "c11_pkg1_docs"),
+                                    "conventional": "docs: pkg1 docs modified outside of pkg 1, identified by path filter",
+                                    "emoji": ":book: pkg1 docs modified outside of pkg 1, identified by path filter",
+                                    "scipy": "DOC: pkg1 docs modified outside of pkg 1, identified by path filter",
+                                    "datetime": next(commit_timestamp_gen),
+                                    "file_to_change": f"{monorepo_pkg1_docs_dir}/index.rst",
+                                },
                             ],
                             commit_type,
                             parser=cast(
@@ -550,7 +563,10 @@ def get_repo_definition_4_trunk_only_monorepo_w_tags(
                                 "details": {
                                     "new_version": pkg1_new_version,
                                     "dest_files": pkg1_changelog_file_definitions,
-                                    "commit_ids": [cid_c10_pkg1_feat],
+                                    "commit_ids": [
+                                        cid_c10_pkg1_feat,
+                                        cid_c11_pkg1_docs,
+                                    ],
                                 },
                             },
                             change_to_pkg1_dir,