python-semantic-release 9.8.0__tar.gz → 9.8.2__tar.gz

{python_semantic_release-9.8.0/python_semantic_release.egg-info → python_semantic_release-9.8.2}/PKG-INFO

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

{python_semantic_release-9.8.0 → python_semantic_release-9.8.2}/docs/changelog_templates.rst

@@ -339,8 +339,7 @@ Below is an example template that can be used to render a Changelog:
 .. code-block::
 
     # CHANGELOG
-    {% if context.history.unreleased | length > 0 %}
-
+    {% if context.history.unreleased | length > 0 -%}
     {# UNRELEASED #}
     ## Unreleased
     {% for type_, commits in context.history.unreleased | dictsort %}
@@ -349,12 +348,9 @@ Below is an example template that can be used to render a Changelog:
     * {{ commit.commit.message.rstrip() }} ([`{{ commit.commit.hexsha[:7] }}`]({{ commit.commit.hexsha | commit_hash_url }}))
     {% else %}
     * {{ commit.commit.message.rstrip() }} ([`{{ commit.commit.hexsha[:7] }}`]({{ commit.commit.hexsha | commit_hash_url }}))
-    {% endif %}{% endfor %}{% endfor %}
-
-    {% endif %}
-
+    {% endif %}{% endfor %}{% endfor %}{% endif -%}
     {# RELEASED #}
-    {% for version, release in context.history.released.items() %}
+    {% for version, release in context.history.released.items() -%}
     ## {{ version.as_tag() }} ({{ release.tagged_date.strftime("%Y-%m-%d") }})
     {% for type_, commits in release["elements"] | dictsort %}
     ### {{ type_ | capitalize }}

{python_semantic_release-9.8.0 → python_semantic_release-9.8.2}/docs/configuration.rst

@@ -207,6 +207,33 @@ PSR_DOCKER_GITHUB_ACTION  Pass-through ``true`` if exists in process env, unset
 VIRTUAL_ENV               Pass-through ``VIRTUAL_ENV`` if exists in process env, unset otherwise
 ========================  ======================================================================
 
+In addition, on windows systems these environment variables are passed:
+========================  ======================================================================
+Variable Name             Description
+========================  ======================================================================
+ALLUSERSAPPDATA           Pass-through ``ALLUSERAPPDATA`` if exists in process env, unset otherwise
+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
+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
+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
+SYSTEMDRIVE               Pass-through ``SYSTEMDRIVE`` if exists in process env, unset otherwise
+SYSTEMROOT                Pass-through ``SYSTEMROOT`` if exists in process env, unset otherwise
+TEMP                      Pass-through ``TEMP`` if exists in process env, unset otherwise
+TMP                       Pass-through ``TMP`` if exists in process env, unset otherwise
+USERPROFILE               Pass-through ``USERPROFILE`` if exists in process env, unset otherwise
+USERSID                   Pass-through ``USERSID`` if exists in process env, unset otherwise
+WINDIR                    Pass-through ``WINDIR`` if exists in process env, unset otherwise
+========================  ======================================================================
+
 **Default:** ``None`` (not specified)
 
 ----

{python_semantic_release-9.8.0 → python_semantic_release-9.8.2}/pyproject.toml

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

{python_semantic_release-9.8.0 → python_semantic_release-9.8.2/python_semantic_release.egg-info}/PKG-INFO

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

{python_semantic_release-9.8.0 → python_semantic_release-9.8.2}/semantic_release/__init__.py

@@ -24,7 +24,7 @@ from semantic_release.version import (
     tags_and_versions,
 )
 
-__version__ = "9.8.0"
+__version__ = "9.8.2"
 
 
 def setup_hook(argv: list[str]) -> None:

{python_semantic_release-9.8.0 → python_semantic_release-9.8.2}/semantic_release/cli/commands/version.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import logging
 import os
 import subprocess
+import sys
 from contextlib import nullcontext
 from datetime import datetime
 from typing import TYPE_CHECKING
@@ -156,6 +157,40 @@ def shell(
     )
 
 
+def is_windows() -> bool:
+    return sys.platform == "win32"
+
+
+def get_windows_env() -> Mapping[str, str | None]:
+    return {
+        environment_variable: os.getenv(environment_variable, None)
+        for environment_variable in (
+            "ALLUSERSAPPDATA",
+            "ALLUSERSPROFILE",
+            "APPDATA",
+            "COMMONPROGRAMFILES",
+            "COMMONPROGRAMFILES(x86)",
+            "DEFAULTUSERPROFILE",
+            "HOMEPATH",
+            "PATHEXT",
+            "PROFILESFOLDER",
+            "PROGRAMFILES",
+            "PROGRAMFILES(x86)",
+            "SYSTEM",
+            "SYSTEM16",
+            "SYSTEM32",
+            "SYSTEMDRIVE",
+            "SYSTEMPROFILE",
+            "SYSTEMROOT",
+            "TEMP",
+            "TMP",
+            "USERPROFILE",
+            "USERSID",
+            "WINDIR",
+        )
+    }
+
+
 @click.command(
     short_help="Detect and apply a new version",
     context_settings={
@@ -522,6 +557,8 @@ def version(  # noqa: C901
                             "PATH": os.getenv("PATH", ""),
                             "HOME": os.getenv("HOME", None),
                             "VIRTUAL_ENV": os.getenv("VIRTUAL_ENV", None),
+                            # Windows environment variables
+                            **(get_windows_env() if is_windows() else {}),
                             # affects build decisions
                             "CI": os.getenv("CI", None),
                             # Identifies which CI environment

{python_semantic_release-9.8.0 → python_semantic_release-9.8.2}/semantic_release/data/templates/CHANGELOG.md.j2

@@ -1,5 +1,5 @@
 # CHANGELOG
-{% if context.history.unreleased | length > 0 %}
+{% if context.history.unreleased | length > 0 -%}
 {# UNRELEASED #}
 ## Unreleased
 {% for type_, commits in context.history.unreleased | dictsort %}
@@ -8,8 +8,8 @@
 * {{ commit.message.rstrip() }} ([`{{ commit.short_hash }}`]({{ commit.hexsha | commit_hash_url }}))
 {% else %}
 * {{ commit.message.rstrip() }} ([`{{ commit.short_hash }}`]({{ commit.hexsha | commit_hash_url }}))
-{% endif %}{% endfor %}{% endfor %}{% endif %}
-{% for version, release in context.history.released.items() %}
+{% endif %}{% endfor %}{% endfor %}{% endif -%}
+{% for version, release in context.history.released.items() -%}
 {# RELEASED #}
 ## {{ version.as_semver_tag() }} ({{ release.tagged_date.strftime("%Y-%m-%d") }})
 {% for type_, commits in release["elements"] | dictsort %}

{python_semantic_release-9.8.0 → python_semantic_release-9.8.2}/tests/command_line/test_version.py

@@ -619,6 +619,28 @@ def test_version_runs_build_command(
         "GITEA_ACTIONS": "true",
         "BITBUCKET_REPO_FULL_NAME": "python-semantic-release/python-semantic-release.git",
         "PSR_DOCKER_GITHUB_ACTION": "true",
+        # Windows
+        "ALLUSERSAPPDATA": "C:\\ProgramData",
+        "ALLUSERSPROFILE": "C:\\ProgramData",
+        "APPDATA": "C:\\Users\\Username\\AppData\\Roaming",
+        "COMMONPROGRAMFILES": "C:\\Program Files\\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)",
+        "SYSTEM": "C:\\Windows\\System32",
+        "SYSTEM16": "C:\\Windows\\System16",
+        "SYSTEM32": "C:\\Windows\\System32",
+        "SYSTEMDRIVE": "C:",
+        "SYSTEMROOT": "C:\\Windows",
+        "TEMP": "C:\\Users\\Username\\AppData\\Local\\Temp",
+        "TMP": "C:\\Users\\Username\\AppData\\Local\\Temp",
+        "USERPROFILE": "C:\\Users\\Username",
+        "USERSID": "S-1-5-21-1234567890-123456789-123456789-1234",
+        "WINDIR": "C:\\Windows",
     }
 
     # Mock out subprocess.run
@@ -626,7 +648,9 @@ def test_version_runs_build_command(
         "subprocess.run", return_value=CompletedProcess(args=(), returncode=0)
     ) as patched_subprocess_run, mock.patch(
         "shellingham.detect_shell", return_value=(exe, shell)
-    ), mock.patch.dict("os.environ", patched_os_environment, clear=True):
+    ), mock.patch("sys.platform", "linux"), mock.patch.dict(
+        "os.environ", patched_os_environment, clear=True
+    ):
         # ACT: run & force a new version that will trigger the build command
         result = cli_runner.invoke(
             main, [version_subcmd or "version", "--patch", "--no-push"]
@@ -653,6 +677,110 @@ def test_version_runs_build_command(
         )
 
 
+@pytest.mark.parametrize("shell", ("powershell", "cmd"))
+def test_version_runs_build_command_windows(
+    repo_with_git_flow_angular_commits: Repo,
+    cli_runner: CliRunner,
+    update_pyproject_toml: UpdatePyprojectTomlFn,
+    shell: str,
+):
+    # Setup
+    build_command = "bash -c \"echo 'hello world'\""
+    update_pyproject_toml("tool.semantic_release.build_command", 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"),
+        # Simulate that all CI's are set
+        "GITHUB_ACTIONS": "true",
+        "GITLAB_CI": "true",
+        "GITEA_ACTIONS": "true",
+        "BITBUCKET_REPO_FULL_NAME": "python-semantic-release/python-semantic-release.git",
+        "PSR_DOCKER_GITHUB_ACTION": "true",
+        # Windows
+        "ALLUSERSAPPDATA": "C:\\ProgramData",
+        "ALLUSERSPROFILE": "C:\\ProgramData",
+        "APPDATA": "C:\\Users\\Username\\AppData\\Roaming",
+        "COMMONPROGRAMFILES": "C:\\Program Files\\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)",
+        "SYSTEM": "C:\\Windows\\System32",
+        "SYSTEM16": "C:\\Windows\\System16",
+        "SYSTEM32": "C:\\Windows\\System32",
+        "SYSTEMDRIVE": "C:",
+        "SYSTEMROOT": "C:\\Windows",
+        "TEMP": "C:\\Users\\Username\\AppData\\Local\\Temp",
+        "TMP": "C:\\Users\\Username\\AppData\\Local\\Temp",
+        "USERPROFILE": "C:\\Users\\Username",
+        "USERSID": "S-1-5-21-1234567890-123456789-123456789-1234",
+        "WINDIR": "C:\\Windows",
+    }
+
+    # Mock out subprocess.run
+    with mock.patch(
+        "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
+    ):
+        # ACT: run & force a new version that will trigger the build command
+        result = cli_runner.invoke(
+            main, [version_subcmd or "version", "--patch", "--no-push"]
+        )
+        assert result.exit_code == 0
+
+        patched_subprocess_run.assert_called_once_with(
+            [exe, "-c" if shell != "cmd" else "/c", build_command],
+            check=True,
+            env={
+                "NEW_VERSION": "1.2.1",  # injected into environment
+                "CI": patched_os_environment["CI"],
+                "BITBUCKET_CI": "true",  # Converted
+                "GITHUB_ACTIONS": patched_os_environment["GITHUB_ACTIONS"],
+                "GITEA_ACTIONS": patched_os_environment["GITEA_ACTIONS"],
+                "GITLAB_CI": patched_os_environment["GITLAB_CI"],
+                "HOME": patched_os_environment["HOME"],
+                "PATH": patched_os_environment["PATH"],
+                "VIRTUAL_ENV": patched_os_environment["VIRTUAL_ENV"],
+                "PSR_DOCKER_GITHUB_ACTION": patched_os_environment[
+                    "PSR_DOCKER_GITHUB_ACTION"
+                ],
+                # Windows
+                "ALLUSERSAPPDATA": patched_os_environment["ALLUSERSAPPDATA"],
+                "ALLUSERSPROFILE": patched_os_environment["ALLUSERSPROFILE"],
+                "APPDATA": patched_os_environment["APPDATA"],
+                "COMMONPROGRAMFILES": patched_os_environment["COMMONPROGRAMFILES"],
+                "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)"],
+                "SYSTEM": patched_os_environment["SYSTEM"],
+                "SYSTEM16": patched_os_environment["SYSTEM16"],
+                "SYSTEM32": patched_os_environment["SYSTEM32"],
+                "SYSTEMDRIVE": patched_os_environment["SYSTEMDRIVE"],
+                "SYSTEMROOT": patched_os_environment["SYSTEMROOT"],
+                "TEMP": patched_os_environment["TEMP"],
+                "TMP": patched_os_environment["TMP"],
+                "USERPROFILE": patched_os_environment["USERPROFILE"],
+                "USERSID": patched_os_environment["USERSID"],
+                "WINDIR": patched_os_environment["WINDIR"],
+            },
+        )
+
+
 def test_version_runs_build_command_w_user_env(
     repo_with_git_flow_angular_commits: Repo,
     cli_runner: CliRunner,

{python_semantic_release-9.8.0 → python_semantic_release-9.8.2}/tests/fixtures/git_repo.py

@@ -21,7 +21,7 @@ from tests.util import (
 )
 
 if TYPE_CHECKING:
-    from typing import Generator, Literal, Protocol, TypedDict, Union
+    from typing import Generator, Protocol, TypedDict, Union
 
     from semantic_release.hvcs import HvcsBase
 
@@ -34,7 +34,7 @@ if TYPE_CHECKING:
         UseParserFn,
     )
 
-    CommitConvention = Literal["angular", "emoji", "scipy", "tag"] | str
+    CommitConvention = str
     VersionStr = str
     CommitMsg = str
     ChangelogTypeHeading = str
@@ -331,15 +331,13 @@ def simulate_default_changelog_creation() -> SimulateDefaultChangelogCreationFn:
         if version == "Unreleased":
             version_entry.append(f"## {version}\n")
         else:
-            version_entry.append(
-                # TODO: artificial newline in front due to template when no Unreleased changes exist
-                f"\n## v{version} ({TODAY_DATE_STR})\n"
-            )
+            version_entry.append(f"## v{version} ({TODAY_DATE_STR})\n")
 
         for section_def in version_def["changelog_sections"]:
             version_entry.append(f"### {section_def['section']}\n")
-            for i in section_def["i_commits"]:
-                version_entry.append(f"* {version_def['commits'][i]}\n")
+            version_entry.extend(
+                [f"* {version_def['commits'][i]}\n" for i in section_def["i_commits"]]
+            )
 
         return str.join("\n", version_entry)
 
@@ -355,7 +353,7 @@ def simulate_default_changelog_creation() -> SimulateDefaultChangelogCreationFn:
             version_entries.insert(0, build_version_entry(version, version_def))
 
         changelog_content = (
-            str.join("\n" * 3, [header, str.join("\n", list(version_entries))]).rstrip()
+            str.join("\n" * 2, [header, str.join("\n", list(version_entries))]).rstrip()
             + "\n"
         )
 

{python_semantic_release-9.8.0 → python_semantic_release-9.8.2}/tests/fixtures/scipy.py

@@ -394,44 +394,3 @@ def scipy_major_mixed_commits(
             ),
         )
     )
-
-
-# @pytest.fixture(
-#     params=xdist_sort_hack(
-#         [
-#             k
-#             for k, v in ScipyParserOptions().tag_to_level.items()
-#             if v is LevelBump.MAJOR
-#         ]
-#     )
-# )
-# def scipy_major_commits(request, subject, default_scipy_parser_options):
-#     patch_tags = [
-#         k
-#         for k, v in default_scipy_parser_options.tag_to_level.items()
-#         if v is LevelBump.PATCH
-#     ]
-#     minor_tags = [
-#         k
-#         for k, v in default_scipy_parser_options.tag_to_level.items()
-#         if v is LevelBump.MINOR
-#     ]
-#     patch_commits = [
-#         _make_scipy_commit(random.choice(patch_tags), subject, body_parts)
-#         for body_parts in SCIPY_FORMATTED_COMMIT_BODY_PARTS
-#     ]
-#     minor_commits = [
-#         _make_scipy_commit(random.choice(minor_tags), subject, body_parts)
-#         for body_parts in SCIPY_FORMATTED_COMMIT_BODY_PARTS
-#     ]
-#     major_commits = [
-#         _make_scipy_commit(request.param, subject, body_parts)
-#         for body_parts in SCIPY_FORMATTED_COMMIT_BODY_PARTS
-#     ]
-#     return list(
-#         chain.from_iterable(
-#             zip_longest(
-#                 major_commits, minor_commits, patch_commits, fillvalue="uninteresting"
-#             )
-#         )
-#     )

{python_semantic_release-9.8.0 → python_semantic_release-9.8.2}/tests/scenario/test_next_version.py

@@ -802,10 +802,9 @@ def test_algorithm_no_zero_dot_versions_tag(
                         )
                     ),
                     *(
-                        # when allow_zero_version is True,
-                        # prerelease is True, & major_on_zero is False, the version should be
-                        # minor bumped, when given commits of a minor or major level because
-                        # major_on_zero = False
+                        # when allow_zero_version is True, prerelease is True, & major_on_zero
+                        # is False, the version should be minor bumped, when given commits of a
+                        # minor or major level because major_on_zero = False
                         (commits, False, False, True, "0.3.0")
                         for commits in (
                             lazy_fixture(angular_minor_commits.__name__),
@@ -1212,10 +1211,9 @@ def test_algorithm_with_zero_dot_versions_angular(
                         )
                     ),
                     *(
-                        # when allow_zero_version is True,
-                        # prerelease is True, & major_on_zero is False, the version should be
-                        # minor bumped, when given commits of a minor or major level because
-                        # major_on_zero = False
+                        # when allow_zero_version is True, prerelease is True, & major_on_zero
+                        # is False, the version should be minor bumped, when given commits of a
+                        # minor or major level because major_on_zero = False
                         (commits, False, False, True, "0.3.0")
                         for commits in (
                             lazy_fixture(emoji_minor_commits.__name__),
@@ -1622,10 +1620,9 @@ def test_algorithm_with_zero_dot_versions_emoji(
                         )
                     ),
                     *(
-                        # when allow_zero_version is True,
-                        # prerelease is True, & major_on_zero is False, the version should be
-                        # minor bumped, when given commits of a minor or major level because
-                        # major_on_zero = False
+                        # when allow_zero_version is True, prerelease is True, & major_on_zero
+                        # is False, the version should be minor bumped, when given commits of a
+                        # minor or major level because major_on_zero = False
                         (commits, False, False, True, "0.3.0")
                         for commits in (
                             lazy_fixture(scipy_minor_commits.__name__),
@@ -2026,10 +2023,10 @@ def test_algorithm_with_zero_dot_versions_scipy(
                         )
                     ),
                     *(
-                        # when allow_zero_version is True,
-                        # prerelease is True, & major_on_zero is False, the version should be
-                        # minor bumped, when given commits of a minor or major level because
-                        # major_on_zero = False
+                        # when allow_zero_version is True, prerelease is True,
+                        # & major_on_zero is False, the version should be minor
+                        # bumped, when given commits of a minor or major level
+                        # because major_on_zero = False
                         (commits, False, False, True, "0.3.0")
                         for commits in (
                             lazy_fixture(tag_minor_commits.__name__),