python-semantic-release 9.8.7__tar.gz → 9.8.8__tar.gz

{python_semantic_release-9.8.7/python_semantic_release.egg-info → python_semantic_release-9.8.8}/PKG-INFO

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

{python_semantic_release-9.8.7 → python_semantic_release-9.8.8}/docs/automatic-releases/github-actions.rst

@@ -53,7 +53,7 @@ Example Workflow
           - name: Python Semantic Release
             # Adjust tag with desired version if applicable. Version shorthand
             # is NOT available, e.g. vX or vX.X will not work.
-            uses: python-semantic-release/python-semantic-release@v9.8.7
+            uses: python-semantic-release/python-semantic-release@v9.8.8
             with:
               github_token: ${{ secrets.GITHUB_TOKEN }}
 
@@ -94,13 +94,13 @@ multiple projects.
 .. code:: yaml
 
    - name: Release Project 1
-     uses: python-semantic-release/python-semantic-release@v9.8.7
+     uses: python-semantic-release/python-semantic-release@v9.8.8
      with:
        directory: ./project1
        github_token: ${{ secrets.GITHUB_TOKEN }}
 
    - name: Release Project 2
-     uses: python-semantic-release/python-semantic-release@v9.8.7
+     uses: python-semantic-release/python-semantic-release@v9.8.8
      with:
        directory: ./project2
        github_token: ${{ secrets.GITHUB_TOKEN }}

{python_semantic_release-9.8.7 → python_semantic_release-9.8.8}/docs/configuration.rst

@@ -216,13 +216,13 @@ ALLUSERSAPPDATA           Pass-through ``ALLUSERAPPDATA`` if exists in process e
 ALLUSERSPROFILE           Pass-through ``ALLUSERSPPPROFILE`` if exists in process env, unset otherwise
 APPDATA                   Pass-through ``APPDATA`` if exists in process env, unset otherwise
 COMMONPROGRAMFILES        Pass-through ``COMMONPROGRAMFILES`` if exists in process env, unset otherwise
-COMMONPROGRAMFILES(x86)   Pass-through ``COMMONPROGRAMFILES(x86)`` if exists in process env, unset otherwise
+COMMONPROGRAMFILES(X86)   Pass-through ``COMMONPROGRAMFILES(X86)`` if exists in process env, unset otherwise
 DEFAULTUSERPROFILE        Pass-through ``DEFAULTUSERPROFILE`` if exists in process env, unset otherwise
 HOMEPATH                  Pass-through ``HOMEPATH`` if exists in process env, unset otherwise
 PATHEXT                   Pass-through ``PATHEXT`` if exists in process env, unset otherwise
 PROFILESFOLDER            Pass-through ``PROFILESFOLDER`` if exists in process env, unset otherwise
 PROGRAMFILES              Pass-through ``PROGRAMFILES`` if exists in process env, unset otherwise
-PROGRAMFILES(x86)         Pass-through ``PROGRAMFILES(x86)`` if exists in process env, unset otherwise
+PROGRAMFILES(X86)         Pass-through ``PROGRAMFILES(X86)`` if exists in process env, unset otherwise
 SYSTEM                    Pass-through ``SYSTEM`` if exists in process env, unset otherwise
 SYSTEM16                  Pass-through ``SYSTEM16`` if exists in process env, unset otherwise
 SYSTEM32                  Pass-through ``SYSTEM32`` if exists in process env, unset otherwise

{python_semantic_release-9.8.7 → python_semantic_release-9.8.8}/docs/github-action.rst

@@ -131,7 +131,7 @@ provide the following inputs:
    - name: Python Semantic Release
      # Adjust tag with desired version if applicable. Version shorthand
      # is NOT available, e.g. vX or vX.X will not work.
-     uses: python-semantic-release/python-semantic-release@v9.8.7
+     uses: python-semantic-release/python-semantic-release@v9.8.8
      with:
        # ... other options
        force: "patch"

{python_semantic_release-9.8.7 → python_semantic_release-9.8.8}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-semantic-release"
-version = "9.8.7"
+version = "9.8.8"
 description = "Automatic Semantic Versioning for Python projects"
 requires-python = ">=3.8"
 license = { text = "MIT" }
@@ -376,6 +376,7 @@ logging_use_named_masks = true
 commit_parser = "angular"
 build_command = """
     python -m scripts.bump_version_in_docs
+    git add docs/*
     python -m pip install -e .[build]
     python -m build .
 """

{python_semantic_release-9.8.7 → python_semantic_release-9.8.8/python_semantic_release.egg-info}/PKG-INFO

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

{python_semantic_release-9.8.7 → python_semantic_release-9.8.8}/semantic_release/__init__.py

@@ -24,7 +24,7 @@ from semantic_release.version import (
     tags_and_versions,
 )
 
-__version__ = "9.8.7"
+__version__ = "9.8.8"
 
 __all__ = [
     "CommitParser",

{python_semantic_release-9.8.7 → python_semantic_release-9.8.8}/semantic_release/cli/commands/version.py

@@ -189,13 +189,13 @@ def get_windows_env() -> Mapping[str, str | None]:
             "ALLUSERSPROFILE",
             "APPDATA",
             "COMMONPROGRAMFILES",
-            "COMMONPROGRAMFILES(x86)",
+            "COMMONPROGRAMFILES(X86)",
             "DEFAULTUSERPROFILE",
             "HOMEPATH",
             "PATHEXT",
             "PROFILESFOLDER",
             "PROGRAMFILES",
-            "PROGRAMFILES(x86)",
+            "PROGRAMFILES(X86)",
             "SYSTEM",
             "SYSTEM16",
             "SYSTEM32",

{python_semantic_release-9.8.7 → python_semantic_release-9.8.8}/semantic_release/cli/config.py

@@ -568,7 +568,12 @@ class RuntimeContext:
         )
 
         # changelog_file
-        changelog_file = Path(raw.changelog.changelog_file).expanduser().resolve()
+        # Must use absolute after resolve because windows does not resolve if the path does not exist
+        # which means it returns a relative path. So we force absolute to ensure path is complete
+        # for the next check of path matching
+        changelog_file = (
+            Path(raw.changelog.changelog_file).expanduser().resolve().absolute()
+        )
 
         # Prevent path traversal attacks
         if raw.repo_dir not in changelog_file.parents:
@@ -576,7 +581,12 @@ class RuntimeContext:
                 "Changelog file destination must be inside of the repository directory."
             )
 
-        template_dir = Path(raw.changelog.template_dir).expanduser().resolve()
+        # Must use absolute after resolve because windows does not resolve if the path does not exist
+        # which means it returns a relative path. So we force absolute to ensure path is complete
+        # for the next check of path matching
+        template_dir = (
+            Path(raw.changelog.template_dir).expanduser().resolve().absolute()
+        )
 
         # Prevent path traversal attacks
         if raw.repo_dir not in template_dir.parents:

{python_semantic_release-9.8.7 → python_semantic_release-9.8.8}/tests/command_line/test_changelog.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import filecmp
 import os
 import shutil
+import sys
 from typing import TYPE_CHECKING
 from unittest import mock
 
@@ -11,6 +12,7 @@ import requests_mock
 from pytest_lazy_fixtures.lazy_fixture import lf as lazy_fixture
 from requests import Session
 
+import semantic_release.hvcs.github
 from semantic_release.cli.commands.main import main
 
 from tests.const import (
@@ -226,17 +228,7 @@ def test_changelog_release_tag_not_in_history(
     repo_with_single_branch_and_prereleases_angular_commits.__name__
 )
 @pytest.mark.parametrize("args", [("--post-to-release-tag", "v0.1.0")])
-def test_changelog_post_to_release(
-    args: list[str],
-    monkeypatch: pytest.MonkeyPatch,
-    tmp_path_factory: pytest.TempPathFactory,
-    example_project_dir: ExProjectDir,
-    cli_runner: CliRunner,
-):
-    tempdir = tmp_path_factory.mktemp("test_changelog")
-    remove_dir_tree(tempdir.resolve(), force=True)
-    shutil.copytree(src=str(example_project_dir.resolve()), dst=tempdir)
-
+def test_changelog_post_to_release(args: list[str], cli_runner: CliRunner):
     # Set up a requests HTTP session so we can catch the HTTP calls and ensure they're
     # made
 
@@ -256,19 +248,63 @@ def test_changelog_post_to_release(
         repo_name=EXAMPLE_REPO_NAME,
     )
 
+    clean_os_environment = dict(
+        filter(
+            lambda k_v: k_v[1] is not None,
+            {
+                "CI": "true",
+                "PATH": os.getenv("PATH"),
+                "HOME": os.getenv("HOME"),
+                "VIRTUAL_ENV": os.getenv("VIRTUAL_ENV", "./.venv"),
+                **(
+                    {}
+                    if sys.platform != "win32"
+                    else {
+                        # Windows Required variables
+                        "ALLUSERSAPPDATA": os.getenv("ALLUSERSAPPDATA"),
+                        "ALLUSERSPROFILE": os.getenv("ALLUSERSPROFILE"),
+                        "APPDATA": os.getenv("APPDATA"),
+                        "COMMONPROGRAMFILES": os.getenv("COMMONPROGRAMFILES"),
+                        "COMMONPROGRAMFILES(X86)": os.getenv("COMMONPROGRAMFILES(X86)"),
+                        "DEFAULTUSERPROFILE": os.getenv("DEFAULTUSERPROFILE"),
+                        "HOMEPATH": os.getenv("HOMEPATH"),
+                        "PATHEXT": os.getenv("PATHEXT"),
+                        "PROFILESFOLDER": os.getenv("PROFILESFOLDER"),
+                        "PROGRAMFILES": os.getenv("PROGRAMFILES"),
+                        "PROGRAMFILES(X86)": os.getenv("PROGRAMFILES(X86)"),
+                        "SYSTEM": os.getenv("SYSTEM"),
+                        "SYSTEM16": os.getenv("SYSTEM16"),
+                        "SYSTEM32": os.getenv("SYSTEM32"),
+                        "SYSTEMDRIVE": os.getenv("SYSTEMDRIVE"),
+                        "SYSTEMROOT": os.getenv("SYSTEMROOT"),
+                        "TEMP": os.getenv("TEMP"),
+                        "TMP": os.getenv("TMP"),
+                        "USERPROFILE": os.getenv("USERPROFILE"),
+                        "USERSID": os.getenv("USERSID"),
+                        "USERNAME": os.getenv("USERNAME"),
+                        "WINDIR": os.getenv("WINDIR"),
+                    }
+                ),
+            }.items(),
+        )
+    )
+
     # Patch out env vars that affect changelog URLs but only get set in e.g.
     # Github actions
     with mock.patch(
-        "semantic_release.hvcs.github.build_requests_session",
+        # Patching the specific module's reference to the build_requests_session function
+        f"{semantic_release.hvcs.github.__name__}.{semantic_release.hvcs.github.build_requests_session.__name__}",
         return_value=session,
-    ) as mocker, mock.patch.dict("os.environ", {}, clear=True):
+    ) as build_requests_session_mock, mock.patch.dict(
+        os.environ, clean_os_environment, clear=True
+    ):
         # Act
         cli_cmd = [MAIN_PROG_NAME, CHANGELOG_SUBCMD, *args]
         result = cli_runner.invoke(main, cli_cmd[1:])
 
     # Evaluate
     assert_successful_exit_code(result, cli_cmd)
-    assert mocker.called
+    assert build_requests_session_mock.called
     assert mock_adapter.called
     assert mock_adapter.last_request is not None
     assert expected_request_url == mock_adapter.last_request.url

{python_semantic_release-9.8.7 → python_semantic_release-9.8.8}/tests/command_line/test_version.py

@@ -5,6 +5,7 @@ import filecmp
 import os
 import re
 import shutil
+import subprocess
 from pathlib import Path
 from subprocess import CompletedProcess
 from textwrap import dedent
@@ -37,6 +38,7 @@ from tests.util import (
     assert_exit_code,
     assert_successful_exit_code,
     flatten_dircmp,
+    get_func_qual_name,
     get_release_history_from_context,
     remove_dir_tree,
 )
@@ -513,7 +515,7 @@ def test_version_no_push_force_level(
         [
             "CHANGELOG.md",
             "pyproject.toml",
-            f"src/{EXAMPLE_PROJECT_NAME}/_version.py",
+            str(Path(f"src/{EXAMPLE_PROJECT_NAME}/_version.py")),
         ]
     )
 
@@ -671,9 +673,9 @@ def test_version_runs_build_command(
     exe = shell.split("/")[-1]
     patched_os_environment = {
         "CI": "true",
-        "PATH": os.getenv("PATH"),
-        "HOME": os.getenv("HOME"),
-        "VIRTUAL_ENV": os.getenv("VIRTUAL_ENV", "./.venv"),
+        "PATH": os.getenv("PATH", ""),
+        "HOME": "/home/username",
+        "VIRTUAL_ENV": "./.venv",
         # Simulate that all CI's are set
         "GITHUB_ACTIONS": "true",
         "GITLAB_CI": "true",
@@ -685,13 +687,13 @@ def test_version_runs_build_command(
         "ALLUSERSPROFILE": "C:\\ProgramData",
         "APPDATA": "C:\\Users\\Username\\AppData\\Roaming",
         "COMMONPROGRAMFILES": "C:\\Program Files\\Common Files",
-        "COMMONPROGRAMFILES(x86)": "C:\\Program Files (x86)\\Common Files",
+        "COMMONPROGRAMFILES(X86)": "C:\\Program Files (x86)\\Common Files",
         "DEFAULTUSERPROFILE": "C:\\Users\\Default",
         "HOMEPATH": "\\Users\\Username",
         "PATHEXT": ".COM;.EXE;.BAT;.CMD;.VBS;.VBE;.JS;.JSE;.WSF;.WSH;.MSC",
         "PROFILESFOLDER": "C:\\Users",
         "PROGRAMFILES": "C:\\Program Files",
-        "PROGRAMFILES(x86)": "C:\\Program Files (x86)",
+        "PROGRAMFILES(X86)": "C:\\Program Files (x86)",
         "SYSTEM": "C:\\Windows\\System32",
         "SYSTEM16": "C:\\Windows\\System16",
         "SYSTEM32": "C:\\Windows\\System32",
@@ -701,16 +703,18 @@ def test_version_runs_build_command(
         "TMP": "C:\\Users\\Username\\AppData\\Local\\Temp",
         "USERPROFILE": "C:\\Users\\Username",
         "USERSID": "S-1-5-21-1234567890-123456789-123456789-1234",
+        "USERNAME": "Username",  # must include for python getpass.getuser() on windows
         "WINDIR": "C:\\Windows",
     }
 
     # Mock out subprocess.run
     with mock.patch(
-        "subprocess.run", return_value=CompletedProcess(args=(), returncode=0)
+        get_func_qual_name(subprocess.run),
+        return_value=CompletedProcess(args=(), returncode=0),
     ) as patched_subprocess_run, mock.patch(
         "shellingham.detect_shell", return_value=(exe, shell)
     ), mock.patch("sys.platform", "linux"), mock.patch.dict(
-        "os.environ", patched_os_environment, clear=True
+        os.environ, patched_os_environment, clear=True
     ):
         cli_cmd = [MAIN_PROG_NAME, VERSION_SUBCMD, "--patch", "--no-push"]
 
@@ -752,9 +756,9 @@ def test_version_runs_build_command_windows(
     exe = shell.split("/")[-1]
     patched_os_environment = {
         "CI": "true",
-        "PATH": os.getenv("PATH"),
-        "HOME": os.getenv("HOME"),
-        "VIRTUAL_ENV": os.getenv("VIRTUAL_ENV", "./.venv"),
+        "PATH": os.getenv("PATH", ""),
+        "HOME": "/home/username",
+        "VIRTUAL_ENV": "./.venv",
         # Simulate that all CI's are set
         "GITHUB_ACTIONS": "true",
         "GITLAB_CI": "true",
@@ -766,13 +770,13 @@ def test_version_runs_build_command_windows(
         "ALLUSERSPROFILE": "C:\\ProgramData",
         "APPDATA": "C:\\Users\\Username\\AppData\\Roaming",
         "COMMONPROGRAMFILES": "C:\\Program Files\\Common Files",
-        "COMMONPROGRAMFILES(x86)": "C:\\Program Files (x86)\\Common Files",
+        "COMMONPROGRAMFILES(X86)": "C:\\Program Files (x86)\\Common Files",
         "DEFAULTUSERPROFILE": "C:\\Users\\Default",
         "HOMEPATH": "\\Users\\Username",
         "PATHEXT": ".COM;.EXE;.BAT;.CMD;.VBS;.VBE;.JS;.JSE;.WSF;.WSH;.MSC",
         "PROFILESFOLDER": "C:\\Users",
         "PROGRAMFILES": "C:\\Program Files",
-        "PROGRAMFILES(x86)": "C:\\Program Files (x86)",
+        "PROGRAMFILES(X86)": "C:\\Program Files (x86)",
         "SYSTEM": "C:\\Windows\\System32",
         "SYSTEM16": "C:\\Windows\\System16",
         "SYSTEM32": "C:\\Windows\\System32",
@@ -782,16 +786,18 @@ def test_version_runs_build_command_windows(
         "TMP": "C:\\Users\\Username\\AppData\\Local\\Temp",
         "USERPROFILE": "C:\\Users\\Username",
         "USERSID": "S-1-5-21-1234567890-123456789-123456789-1234",
+        "USERNAME": "Username",  # must include for python getpass.getuser() on windows
         "WINDIR": "C:\\Windows",
     }
 
     # Mock out subprocess.run
     with mock.patch(
-        "subprocess.run", return_value=CompletedProcess(args=(), returncode=0)
+        get_func_qual_name(subprocess.run),
+        return_value=CompletedProcess(args=(), returncode=0),
     ) as patched_subprocess_run, mock.patch(
         "shellingham.detect_shell", return_value=(exe, shell)
     ), mock.patch("sys.platform", "win32"), mock.patch.dict(
-        "os.environ", patched_os_environment, clear=True
+        os.environ, patched_os_environment, clear=True
     ):
         cli_cmd = [MAIN_PROG_NAME, VERSION_SUBCMD, "--patch", "--no-push"]
 
@@ -821,15 +827,15 @@ def test_version_runs_build_command_windows(
                 "ALLUSERSPROFILE": patched_os_environment["ALLUSERSPROFILE"],
                 "APPDATA": patched_os_environment["APPDATA"],
                 "COMMONPROGRAMFILES": patched_os_environment["COMMONPROGRAMFILES"],
-                "COMMONPROGRAMFILES(x86)": patched_os_environment[
-                    "COMMONPROGRAMFILES(x86)"
+                "COMMONPROGRAMFILES(X86)": patched_os_environment[
+                    "COMMONPROGRAMFILES(X86)"
                 ],
                 "DEFAULTUSERPROFILE": patched_os_environment["DEFAULTUSERPROFILE"],
                 "HOMEPATH": patched_os_environment["HOMEPATH"],
                 "PATHEXT": patched_os_environment["PATHEXT"],
                 "PROFILESFOLDER": patched_os_environment["PROFILESFOLDER"],
                 "PROGRAMFILES": patched_os_environment["PROGRAMFILES"],
-                "PROGRAMFILES(x86)": patched_os_environment["PROGRAMFILES(x86)"],
+                "PROGRAMFILES(X86)": patched_os_environment["PROGRAMFILES(X86)"],
                 "SYSTEM": patched_os_environment["SYSTEM"],
                 "SYSTEM16": patched_os_environment["SYSTEM16"],
                 "SYSTEM32": patched_os_environment["SYSTEM32"],
@@ -852,9 +858,11 @@ def test_version_runs_build_command_w_user_env(
     # Setup
     patched_os_environment = {
         "CI": "true",
-        "PATH": os.getenv("PATH"),
-        "HOME": os.getenv("HOME"),
-        "VIRTUAL_ENV": os.getenv("VIRTUAL_ENV", "./.venv"),
+        "PATH": os.getenv("PATH", ""),
+        "HOME": "/home/username",
+        "VIRTUAL_ENV": "./.venv",
+        # Windows
+        "USERNAME": "Username",  # must include for python getpass.getuser() on windows
         # Simulate that all CI's are set
         "GITHUB_ACTIONS": "true",
         "GITLAB_CI": "true",
@@ -884,10 +892,11 @@ def test_version_runs_build_command_w_user_env(
 
     # Mock out subprocess.run
     with mock.patch(
-        "subprocess.run", return_value=CompletedProcess(args=(), returncode=0)
+        get_func_qual_name(subprocess.run),
+        return_value=CompletedProcess(args=(), returncode=0),
     ) as patched_subprocess_run, mock.patch(
         "shellingham.detect_shell", return_value=("bash", "/usr/bin/bash")
-    ), mock.patch.dict("os.environ", patched_os_environment, clear=True):
+    ), mock.patch.dict(os.environ, patched_os_environment, clear=True):
         cli_cmd = [
             MAIN_PROG_NAME,
             VERSION_SUBCMD,
@@ -938,7 +947,8 @@ def test_version_skips_build_command_with_skip_build(
     cli_cmd = [MAIN_PROG_NAME, VERSION_SUBCMD, "--patch", "--no-push", "--skip-build"]
 
     with mock.patch(
-        "subprocess.run", return_value=CompletedProcess(args=(), returncode=0)
+        get_func_qual_name(subprocess.run),
+        return_value=CompletedProcess(args=(), returncode=0),
     ) as patched_subprocess_run:
         # Act: force a new version
         result = cli_runner.invoke(main, cli_cmd[1:])
@@ -1159,7 +1169,7 @@ def test_version_only_update_files_no_git_actions(
         [
             "CHANGELOG.md",
             "pyproject.toml",
-            f"src/{EXAMPLE_PROJECT_NAME}/_version.py",
+            str(Path(f"src/{EXAMPLE_PROJECT_NAME}/_version.py")),
         ]
     )
     assert expected_changed_files == differing_files

python_semantic_release-9.8.8/tests/conftest.py

@@ -0,0 +1,135 @@
+"""Note: fixtures are stored in the tests/fixtures directory for better organisation"""
+
+from __future__ import annotations
+
+import os
+import sys
+from pathlib import Path
+from tempfile import NamedTemporaryFile
+from typing import TYPE_CHECKING
+
+import pytest
+from git import Commit, Repo
+
+from tests.fixtures import *
+from tests.util import remove_dir_tree
+
+if TYPE_CHECKING:
+    from tempfile import _TemporaryFileWrapper
+    from typing import Generator, Protocol
+
+    class MakeCommitObjFn(Protocol):
+        def __call__(self, message: str) -> Commit: ...
+
+    class NetrcFileFn(Protocol):
+        def __call__(self, machine: str) -> _TemporaryFileWrapper[str]: ...
+
+    class TeardownCachedDirFn(Protocol):
+        def __call__(self, directory: Path) -> Path: ...
+
+
+@pytest.fixture(scope="session")
+def default_netrc_username() -> str:
+    return "username"
+
+
+@pytest.fixture(scope="session")
+def default_netrc_password() -> str:
+    return "password"
+
+
+@pytest.fixture(scope="session")
+def netrc_file(
+    default_netrc_username: str,
+    default_netrc_password: str,
+) -> Generator[NetrcFileFn, None, None]:
+    temporary_files: list[str] = []
+
+    def _netrc_file(machine: str) -> _TemporaryFileWrapper[str]:
+        ctx_mgr = NamedTemporaryFile("w", delete=False)
+        with ctx_mgr as netrc_fd:
+            temporary_files.append(ctx_mgr.name)
+
+            netrc_fd.write(f"machine {machine}{os.linesep}")
+            netrc_fd.write(f"login {default_netrc_username}{os.linesep}")
+            netrc_fd.write(f"password {default_netrc_password}{os.linesep}")
+            netrc_fd.flush()
+            return ctx_mgr
+
+    try:
+        yield _netrc_file
+    finally:
+        for temp_file in temporary_files:
+            os.unlink(temp_file)
+
+
+@pytest.fixture(scope="session")
+def cached_files_dir(tmp_path_factory: pytest.TempPathFactory) -> Path:
+    return tmp_path_factory.mktemp("cached_files_dir")
+
+
+@pytest.fixture(scope="session")
+def teardown_cached_dir() -> Generator[TeardownCachedDirFn, None, None]:
+    directories: list[Path] = []
+
+    def _teardown_cached_dir(directory: Path | str) -> Path:
+        directories.append(Path(directory))
+        return directories[-1]
+
+    try:
+        yield _teardown_cached_dir
+    finally:
+        # clean up any registered cached directories
+        for directory in directories:
+            if directory.exists():
+                remove_dir_tree(directory, force=True)
+
+
+@pytest.fixture(scope="session")
+def make_commit_obj() -> MakeCommitObjFn:
+    def _make_commit(message: str) -> Commit:
+        return Commit(repo=Repo(), binsha=Commit.NULL_BIN_SHA, message=message)
+
+    return _make_commit
+
+
+@pytest.fixture(scope="session")
+def clean_os_environment() -> dict[str, str]:
+    return dict(  # type: ignore
+        filter(
+            lambda k_v: k_v[1] is not None,
+            {
+                "PATH": os.getenv("PATH"),
+                "HOME": os.getenv("HOME"),
+                **(
+                    {}
+                    if sys.platform != "win32"
+                    else {
+                        # Windows Required variables
+                        "ALLUSERSAPPDATA": os.getenv("ALLUSERSAPPDATA"),
+                        "ALLUSERSPROFILE": os.getenv("ALLUSERSPROFILE"),
+                        "APPDATA": os.getenv("APPDATA"),
+                        "COMMONPROGRAMFILES": os.getenv("COMMONPROGRAMFILES"),
+                        "COMMONPROGRAMFILES(X86)": os.getenv("COMMONPROGRAMFILES(X86)"),
+                        "DEFAULTUSERPROFILE": os.getenv("DEFAULTUSERPROFILE"),
+                        "HOMEPATH": os.getenv("HOMEPATH"),
+                        "PATHEXT": os.getenv("PATHEXT"),
+                        "PROFILESFOLDER": os.getenv("PROFILESFOLDER"),
+                        "PROGRAMFILES": os.getenv("PROGRAMFILES"),
+                        "PROGRAMFILES(X86)": os.getenv("PROGRAMFILES(X86)"),
+                        "SYSTEM": os.getenv("SYSTEM"),
+                        "SYSTEM16": os.getenv("SYSTEM16"),
+                        "SYSTEM32": os.getenv("SYSTEM32"),
+                        "SYSTEMDRIVE": os.getenv("SYSTEMDRIVE"),
+                        "SYSTEMROOT": os.getenv("SYSTEMROOT"),
+                        "TEMP": os.getenv("TEMP"),
+                        "TMP": os.getenv("TMP"),
+                        "USERPROFILE": os.getenv("USERPROFILE"),
+                        "USERSID": os.getenv("USERSID"),
+                        "USERNAME": os.getenv("USERNAME"),
+                        "WINDIR": os.getenv("WINDIR"),
+                    }
+                ),
+            }.items(),
+        )
+    )

{python_semantic_release-9.8.7 → python_semantic_release-9.8.8}/tests/const.py

@@ -138,7 +138,7 @@ version_variables = [
     "src/{EXAMPLE_PROJECT_NAME}/_version.py:__version__",
 ]
 version_toml = ["pyproject.toml:tool.poetry.version"]
-"""
+""".lstrip()
 
 EXAMPLE_SETUP_CFG_CONTENT = rf"""
 [metadata]
@@ -202,7 +202,7 @@ line_length=88
 
 [flake8]
 max-line-length = 88
-"""
+""".lstrip()
 
 EXAMPLE_SETUP_PY_CONTENT = rf"""
 import re
@@ -284,7 +284,7 @@ setup(
         "Programming Language :: Python :: 3.9",
     ],
 )
-"""
+""".lstrip()
 
 EXAMPLE_CHANGELOG_MD_CONTENT = r"""
 # CHANGELOG.md
@@ -295,15 +295,16 @@ EXAMPLE_CHANGELOG_MD_CONTENT = r"""
 * Various bugfixes, security enhancements
 * Extra cookies to enhance your experience
 * ~Removed~ simplified cookie opt-out handling logic
-"""
+""".lstrip()
 
-EXAMPLE_RELEASE_NOTES_TEMPLATE = r"""## What's Changed
+EXAMPLE_RELEASE_NOTES_TEMPLATE = r"""
+## What's Changed
 {% for type_, commits in release["elements"] | dictsort %}
 ### {{ type_ | capitalize }}
 {%- if type_ != "unknown" %}
 {% for commit in commits %}
 * {{ commit.commit.summary.rstrip() }} ([`{{ commit.short_hash }}`]({{ commit.hexsha | commit_hash_url }}))
 {%- endfor %}{% endif %}{% endfor %}
-"""  # noqa: E501
+""".lstrip()  # noqa: E501
 
 RELEASE_NOTES = "# Release Notes"

{python_semantic_release-9.8.7 → python_semantic_release-9.8.8}/tests/scenario/test_release_history.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from datetime import datetime
-from typing import NamedTuple
+from typing import TYPE_CHECKING, NamedTuple
 
 import pytest
 from git import Actor
@@ -22,6 +22,9 @@ from tests.fixtures import (
 )
 from tests.util import add_text_to_file
 
+if TYPE_CHECKING:
+    from git import Repo
+
 # NOTE: not testing parser correctness here, just that the right commits end up
 # in the right places. So we only compare that the commits with the messages
 # we anticipate are in the right place, rather than by hash
@@ -315,7 +318,7 @@ def test_release_history(
         lazy_fixture(repo_with_git_flow_and_release_channels_angular_commits.__name__),
     ],
 )
-def test_release_history_releases(repo, default_angular_parser):
+def test_release_history_releases(repo: Repo, default_angular_parser):
     new_version = Version.parse("100.10.1")
     actor = Actor("semantic-release", "semantic-release")
     release_history = ReleaseHistory.from_git_history(