python-semantic-release 9.6.0__tar.gz → 9.7.0__tar.gz

{python_semantic_release-9.6.0/python_semantic_release.egg-info → python_semantic_release-9.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-semantic-release
-Version: 9.6.0
+Version: 9.7.0
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT
@@ -53,9 +53,9 @@ Requires-Dist: types-pytest-lazy-fixture~=0.6.3; extra == "test"
 Provides-Extra: dev
 Requires-Dist: pre-commit~=3.5; extra == "dev"
 Requires-Dist: tox~=4.11; extra == "dev"
-Requires-Dist: ruff==0.4.1; extra == "dev"
+Requires-Dist: ruff==0.4.2; extra == "dev"
 Provides-Extra: mypy
-Requires-Dist: mypy==1.9.0; extra == "mypy"
+Requires-Dist: mypy==1.10.0; extra == "mypy"
 Requires-Dist: types-requests~=2.31.0; extra == "mypy"
 
 Python Semantic Release

{python_semantic_release-9.6.0 → python_semantic_release-9.7.0}/docs/configuration.rst

@@ -141,10 +141,34 @@ This setting is discussed in more detail at :ref:`multibranch-releases`
 
 .. _config-build-command:
 
-``build_command (Optional[str])``
-"""""""""""""""""""""""""""""""""
-
-Command to use when building the current project during :ref:`cmd-version`
+``build_command``
+"""""""""""""""""
+
+**Type:** ``Optional[str]``
+
+Command to use to build the current project during :ref:`cmd-version`.
+
+Python Semantic Release will execute the build command in the OS default
+shell with a subset of environment variables. PSR provides the variable
+``NEW_VERSION`` in the environment with the value of the next determined
+version. The following table summarizes all the environment variables that
+are passed on to the ``build_command`` runtime if they exist in the parent
+process.
+
+========================  ======================================================================
+Variable Name             Description
+========================  ======================================================================
+CI                        Pass-through ``true`` if exists in process env, unset otherwise
+BITBUCKET_CI              ``true`` if Bitbucket CI variables exist in env, unset otherwise
+GITHUB_ACTIONS            Pass-through ``true`` if exists in process env, unset otherwise
+GITEA_ACTIONS             Pass-through ``true`` if exists in process env, unset otherwise
+GITLAB_CI                 Pass-through ``true`` if exists in process env, unset otherwise
+HOME                      Pass-through ``HOME`` of parent process
+NEW_VERSION               Semantically determined next version (ex. ``1.2.3``)
+PATH                      Pass-through ``PATH`` of parent process
+PSR_DOCKER_GITHUB_ACTION  Pass-through ``true`` if exists in process env, unset otherwise
+VIRTUAL_ENV               Pass-through ``VIRTUAL_ENV`` if exists in process env, unset otherwise
+========================  ======================================================================
 
 **Default:** ``None`` (not specified)
 

{python_semantic_release-9.6.0 → python_semantic_release-9.7.0}/docs/github-action.rst

@@ -106,8 +106,8 @@ defaults as their corresponding command line option.
 In general, the input for an action corresponding to a command line option has the same
 name, with dashes (``-``) replaced by underscores.
 
-The command line arguments ``--patch``, ``--minor`` and ``--major`` are mutually
-exclusive, and are supplied via the ``force`` input.
+The command line arguments ``--prerelease``, ``--patch``, ``--minor`` and ``--major``
+are mutually exclusive, and are supplied via the ``force`` input.
 
 Flags, which require either ``--<option>`` or ``--no-<option>`` to be passed on the
 command-line, should be specified using the option name (with dashes replaced by
@@ -115,6 +115,9 @@ underscores), and set to the value ``"true"`` to supply ``--<option>`` on the
 command-line, and ``"false"`` to specify ``--no-<option>``.
 Any other values are not accepted.
 
+The flag ``--as-prerelease`` is uniquely provided as just the ``prerelease`` flag value.
+This is for compatibility reasons.
+
 For command line options requiring a value, set the input to the required value.
 
 For example, to specify ``--patch --no-push --build-metadata abc123``, you should

{python_semantic_release-9.6.0 → python_semantic_release-9.7.0}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-semantic-release"
-version = "9.6.0"
+version = "9.7.0"
 description = "Automatic Semantic Versioning for Python projects"
 requires-python = ">=3.8"
 license = { text = "MIT" }
@@ -71,10 +71,10 @@ test = [
 dev = [
   "pre-commit ~= 3.5",
   "tox ~= 4.11",
-  "ruff == 0.4.1"
+  "ruff == 0.4.2"
 ]
 mypy = [
-  "mypy == 1.9.0",
+  "mypy == 1.10.0",
   "types-requests ~= 2.31.0"
 ]
 
@@ -83,18 +83,21 @@ env = [
   "PYTHONHASHSEED = 123456"
 ]
 addopts = [
+  # TO DEBUG in single process, swap auto to 0
   "-nauto",
+  # "-n0",
   "-ra",
   "--diff-symbols",
   "--cache-clear",
-  "--cov=semantic_release",
-  "--cov-context=test",
-  "--cov-report",
-  "html:coverage-html",
-  "--cov-report",
-  "term",
+  # No default coverage - causes problems with debuggers
+  # "--cov=semantic_release",
+  # "--cov-context=test",
+  # "--cov-report=html:coverage-html",
+  # "--cov-report=term-missing",
+]
+testpaths = [
+  "tests"
 ]
-python_files = ["tests/test_*.py", "tests/**/test_*.py"]
 
 [tool.coverage.html]
 show_contexts = true

{python_semantic_release-9.6.0 → python_semantic_release-9.7.0/python_semantic_release.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-semantic-release
-Version: 9.6.0
+Version: 9.7.0
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT
@@ -53,9 +53,9 @@ Requires-Dist: types-pytest-lazy-fixture~=0.6.3; extra == "test"
 Provides-Extra: dev
 Requires-Dist: pre-commit~=3.5; extra == "dev"
 Requires-Dist: tox~=4.11; extra == "dev"
-Requires-Dist: ruff==0.4.1; extra == "dev"
+Requires-Dist: ruff==0.4.2; extra == "dev"
 Provides-Extra: mypy
-Requires-Dist: mypy==1.9.0; extra == "mypy"
+Requires-Dist: mypy==1.10.0; extra == "mypy"
 Requires-Dist: types-requests~=2.31.0; extra == "mypy"
 
 Python Semantic Release

{python_semantic_release-9.6.0 → python_semantic_release-9.7.0}/python_semantic_release.egg-info/requires.txt

@@ -14,7 +14,7 @@ shellingham~=1.5
 [dev]
 pre-commit~=3.5
 tox~=4.11
-ruff==0.4.1
+ruff==0.4.2
 
 [docs]
 Sphinx~=6.0
@@ -23,7 +23,7 @@ sphinx-autobuild==2024.2.4
 furo~=2024.1
 
 [mypy]
-mypy==1.9.0
+mypy==1.10.0
 types-requests~=2.31.0
 
 [test]

{python_semantic_release-9.6.0 → python_semantic_release-9.7.0}/semantic_release/__init__.py

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

{python_semantic_release-9.6.0 → python_semantic_release-9.7.0}/semantic_release/cli/commands/version.py

@@ -31,7 +31,7 @@ from semantic_release.version import Version, next_version, tags_and_versions
 log = logging.getLogger(__name__)
 
 if TYPE_CHECKING:  # pragma: no cover
-    from typing import ContextManager, Iterable
+    from typing import ContextManager, Iterable, Mapping
 
     from git import Repo
     from git.refs.tag import Tag
@@ -135,7 +135,9 @@ def apply_version_to_source_files(
     return paths
 
 
-def shell(cmd: str, *, check: bool = True) -> subprocess.CompletedProcess:
+def shell(
+    cmd: str, *, env: Mapping[str, str] | None = None, check: bool = True
+) -> subprocess.CompletedProcess:
     shell: str | None
     try:
         shell, _ = shellingham.detect_shell()
@@ -149,6 +151,7 @@ def shell(cmd: str, *, check: bool = True) -> subprocess.CompletedProcess:
 
     return subprocess.run(
         [shell, "-c" if shell != "cmd" else "/c", cmd],  # noqa: S603
+        env=(env or {}),
         check=check,
     )
 
@@ -507,7 +510,35 @@ def version(  # noqa: C901
                 "[bold green]:hammer_and_wrench: Running build command: "
                 + build_command
             )
-            shell(build_command, check=True)
+            shell(
+                build_command,
+                check=True,
+                env=dict(
+                    filter(
+                        lambda k_v: k_v[1] is not None,  # type: ignore
+                        {
+                            "NEW_VERSION": str(new_version),
+                            "PATH": os.getenv("PATH", ""),
+                            "HOME": os.getenv("HOME", None),
+                            "VIRTUAL_ENV": os.getenv("VIRTUAL_ENV", None),
+                            # affects build decisions
+                            "CI": os.getenv("CI", None),
+                            # Identifies which CI environment
+                            "GITHUB_ACTIONS": os.getenv("GITHUB_ACTIONS", None),
+                            "GITLAB_CI": os.getenv("GITLAB_CI", None),
+                            "GITEA_ACTIONS": os.getenv("GITEA_ACTIONS", None),
+                            "BITBUCKET_CI": (
+                                str(True).lower()
+                                if os.getenv("BITBUCKET_REPO_FULL_NAME", None)
+                                else None
+                            ),
+                            "PSR_DOCKER_GITHUB_ACTION": os.getenv(
+                                "PSR_DOCKER_GITHUB_ACTION", None
+                            ),
+                        }.items(),
+                    )
+                ),
+            )
         except subprocess.CalledProcessError as exc:
             ctx.fail(str(exc))
 

{python_semantic_release-9.6.0 → python_semantic_release-9.7.0}/tests/command_line/test_version.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import difflib
 import filecmp
+import os
 import re
 import shutil
 from subprocess import CompletedProcess
@@ -558,13 +559,25 @@ def test_version_runs_build_command(
     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",
+    }
 
     # 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.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"]
@@ -572,7 +585,22 @@ def test_version_runs_build_command(
         assert result.exit_code == 0
 
         patched_subprocess_run.assert_called_once_with(
-            [exe, "-c", build_command], check=True
+            [exe, "-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"
+                ],
+            },
         )