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

{python_semantic_release-9.8.6/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.6
+Version: 9.8.8
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT
@@ -41,17 +41,16 @@ Requires-Dist: sphinx-autobuild==2024.2.4; extra == "docs"
 Requires-Dist: furo~=2024.1; extra == "docs"
 Provides-Extra: test
 Requires-Dist: coverage[toml]~=7.0; extra == "test"
-Requires-Dist: pytest~=7.0; extra == "test"
+Requires-Dist: pytest~=8.3; extra == "test"
 Requires-Dist: pytest-env~=1.0; extra == "test"
 Requires-Dist: pytest-xdist~=3.0; extra == "test"
 Requires-Dist: pytest-mock~=3.0; extra == "test"
-Requires-Dist: pytest-lazy-fixture~=0.6.3; extra == "test"
+Requires-Dist: pytest-lazy-fixtures~=1.1.1; extra == "test"
 Requires-Dist: pytest-cov~=5.0; extra == "test"
 Requires-Dist: pytest-pretty~=1.2; extra == "test"
 Requires-Dist: pytest-clarity~=1.0; extra == "test"
 Requires-Dist: responses~=0.25.0; extra == "test"
 Requires-Dist: requests-mock~=1.10; extra == "test"
-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"

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

@@ -30,40 +30,42 @@ Example Workflow
 
 .. code:: yaml
 
-   name: Semantic Release
-
-   on:
-     push:
-       branches:
-         - master
-
-   jobs:
-     release:
-       runs-on: ubuntu-latest
-       concurrency: release
-       permissions:
-         id-token: write
-         contents: write
-
-       steps:
-       - uses: actions/checkout@v3
-         with:
-           fetch-depth: 0
-
-       - name: Python Semantic Release
-         uses: python-semantic-release/python-semantic-release@master
-         with:
-           github_token: ${{ secrets.GITHUB_TOKEN }}
-
-``concurrency`` is a
-`beta feature of GitHub Actions <https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idconcurrency>`_
-which disallows two or more release jobs to run in parallel. This prevents race
-conditions if there are multiple pushes in a short period of time.
+    name: Semantic Release
+
+    on:
+      push:
+        branches:
+          - master
+
+    jobs:
+      release:
+        runs-on: ubuntu-latest
+        concurrency: release
+        permissions:
+          id-token: write
+          contents: write
+
+        steps:
+          - uses: actions/checkout@v3
+            with:
+              fetch-depth: 0
+
+          - 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.8
+            with:
+              github_token: ${{ secrets.GITHUB_TOKEN }}
+
+``concurrency`` is a `beta feature of GitHub Actions`_ which disallows two or more
+release jobs to run in parallel. This prevents race conditions if there are multiple
+pushes in a short period of time.
 
 If you would like to use Python Semantic Release to create GitHub Releases against
 your repository, you will need to allow the additional ``contents: write`` permission.
 More information can be found in the `permissions for GitHub Apps documentation`_
 
+.. _beta feature of GitHub Actions: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idconcurrency
 .. _permissions for GitHub Apps documentation: https://docs.github.com/en/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#contents
 
 .. warning::
@@ -92,13 +94,13 @@ multiple projects.
 .. code:: yaml
 
    - name: Release Project 1
-     uses: python-semantic-release/python-semantic-release@master
+     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@master
+     uses: python-semantic-release/python-semantic-release@v9.8.8
      with:
        directory: ./project2
        github_token: ${{ secrets.GITHUB_TOKEN }}

{python_semantic_release-9.8.6 → python_semantic_release-9.8.8}/docs/changelog_templates.rst

@@ -3,22 +3,16 @@
 Changelog Templates
 ===================
 
-.. warning::
-    If you have an existing changelog in the location you have configured with
-    the :ref:`changelog_file <config-changelog-changelog_file>` setting,
-    or if you have a template inside your :ref:`template directory <config-changelog-template_dir>`
-    which will render to the location of an existing file, Python Semantic Release will
-    overwrite the contents of this file.
-
-    Please make sure to refer to :ref:`changelog-templates-migrating-existing-changelog`.
 
-Python Semantic Release can write a changelog for your project. By default, it uses an
-in-built template; once rendered this will be written to the location you configure with the
-:ref:`changelog_file <config-changelog-changelog_file>` setting.
+By default, Python Semantic Release (PSR) will generate a changelog for your project. In the default
+configuration, PSR will use a built-in template files to render the changelog at the file location
+defined by the :ref:`changelog_file <config-changelog-changelog_file>` setting.
 
-However, Python Semantic Release is also capable of rendering an entire directory tree
-of templates during the changelog generation process. This directory is specified
-using the :ref:`template directory <config-changelog-template_dir>` setting.
+However, you can customize the appearance and file structure of the changelog generation process
+by creating your own template files. This option is available by setting the
+:ref:`template_dir <config-changelog-template_dir>` configuration and populating the directory
+with your custom template files. It will render the an entire directory tree of templates
+as desired if they exist within the template directory.
 
 Python Semantic Release uses `Jinja`_ as its template engine, so you should refer to the
 `Template Designer Documentation`_ for guidance on how to customize the appearance of
@@ -32,6 +26,15 @@ providing the :ref:`--no-changelog <cmd-version-option-changelog>` command-line
 
 The changelog template is re-rendered on each release.
 
+.. warning::
+    If you have an existing changelog in the location you have configured with
+    the :ref:`changelog_file <config-changelog-changelog_file>` setting,
+    or if you have a template inside your :ref:`template directory <config-changelog-template_dir>`
+    which will render to the location of an existing file, Python Semantic Release will
+    overwrite the contents of this file.
+
+    Please make sure to refer to :ref:`changelog-templates-migrating-existing-changelog`.
+
 .. _Jinja: https://jinja.palletsprojects.com/en/3.1.x/
 .. _Template Designer Documentation: https://jinja.palletsprojects.com/en/3.1.x/templates/
 

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

@@ -208,6 +208,7 @@ VIRTUAL_ENV               Pass-through ``VIRTUAL_ENV`` if exists in process env,
 ========================  ======================================================================
 
 In addition, on windows systems these environment variables are passed:
+
 ========================  ======================================================================
 Variable Name             Description
 ========================  ======================================================================
@@ -215,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
@@ -292,7 +293,12 @@ This section outlines the configuration options available that modify changelog
 
 **Type:** ``str``
 
-Specify the name of the changelog file (after template rendering has taken place).
+Specify the name of the changelog file that will be created. This file will be created
+or overwritten (if it previously exists) with the rendered default template included
+with Python Semantic Release.
+
+If you are using the ``template_dir`` setting for providing customized templates,
+this setting is not used. See :ref:`config-changelog-template_dir` for more information.
 
 **Default:** ``"CHANGELOG.md"``
 
@@ -309,15 +315,14 @@ Specify the name of the changelog file (after template rendering has taken place
    passed directly to the `jinja2.Environment`_ constructor, and further
    documentation one these parameters can be found there.
 
-.. _`jinja2.Environment`: https://jinja.palletsprojects.com/en/3.1.x/api/#jinja2.Environment
-
-.. note::
     **pyproject.toml:** ``[tool.semantic_release.changelog.environment]``
 
     **releaserc.toml:** ``[semantic_release.changelog.environment]``
 
     **releaserc.json:** ``{ "semantic_release": { "changelog": { "environment": {} } } }``
 
+.. _`jinja2.Environment`: https://jinja.palletsprojects.com/en/3.1.x/api/#jinja2.Environment
+
 ----
 
 .. _config-changelog-environment-autoescape:
@@ -540,8 +545,14 @@ The patterns in this list are treated as regular expressions.
 
 **Type:** ``str``
 
-If given, specifies a directory of templates that will be rendered during creation
-of the changelog. If not given, the default changelog template will be used.
+When files exist within the specified directory, they will be used as templates for
+the changelog rendering process. Regardless if the directory includes a changelog file,
+the provided directory will be rendered and files placed relative to the root of the
+project directory.
+
+No default changelog template or release notes template will be used when this directory
+exists and the directory is not empty. If the directory is empty, the default changelog
+template will be used.
 
 This option is discussed in more detail at :ref:`changelog-templates`
 

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

@@ -129,7 +129,9 @@ provide the following inputs:
 
    # ... the rest of the workflow
    - name: Python Semantic Release
-     uses: python-semantic-release/python-semantic-release@v8.0.0
+     # 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.8
      with:
        # ... other options
        force: "patch"

{python_semantic_release-9.8.6 → 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.6"
+version = "9.8.8"
 description = "Automatic Semantic Versioning for Python projects"
 requires-python = ">=3.8"
 license = { text = "MIT" }
@@ -59,17 +59,16 @@ docs = [
 ]
 test = [
   "coverage[toml] ~= 7.0",
-  "pytest ~= 7.0",
+  "pytest ~= 8.3",
   "pytest-env ~= 1.0",
   "pytest-xdist ~= 3.0",
   "pytest-mock ~= 3.0",
-  "pytest-lazy-fixture ~= 0.6.3",
+  "pytest-lazy-fixtures ~= 1.1.1",
   "pytest-cov ~= 5.0",
   "pytest-pretty ~= 1.2",
   "pytest-clarity ~= 1.0",
   "responses ~= 0.25.0",
   "requests-mock ~= 1.10",
-  "types-pytest-lazy-fixture ~= 0.6.3",
 ]
 dev = [
   "pre-commit ~= 3.5",
@@ -376,6 +375,8 @@ ignore_names = ["change_to_ex_proj_dir", "init_example_project"]
 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.6 → 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.6
+Version: 9.8.8
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT
@@ -41,17 +41,16 @@ Requires-Dist: sphinx-autobuild==2024.2.4; extra == "docs"
 Requires-Dist: furo~=2024.1; extra == "docs"
 Provides-Extra: test
 Requires-Dist: coverage[toml]~=7.0; extra == "test"
-Requires-Dist: pytest~=7.0; extra == "test"
+Requires-Dist: pytest~=8.3; extra == "test"
 Requires-Dist: pytest-env~=1.0; extra == "test"
 Requires-Dist: pytest-xdist~=3.0; extra == "test"
 Requires-Dist: pytest-mock~=3.0; extra == "test"
-Requires-Dist: pytest-lazy-fixture~=0.6.3; extra == "test"
+Requires-Dist: pytest-lazy-fixtures~=1.1.1; extra == "test"
 Requires-Dist: pytest-cov~=5.0; extra == "test"
 Requires-Dist: pytest-pretty~=1.2; extra == "test"
 Requires-Dist: pytest-clarity~=1.0; extra == "test"
 Requires-Dist: responses~=0.25.0; extra == "test"
 Requires-Dist: requests-mock~=1.10; extra == "test"
-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"

{python_semantic_release-9.8.6 → python_semantic_release-9.8.8}/python_semantic_release.egg-info/requires.txt

@@ -31,14 +31,13 @@ types-requests~=2.32.0
 
 [test]
 coverage[toml]~=7.0
-pytest~=7.0
+pytest~=8.3
 pytest-env~=1.0
 pytest-xdist~=3.0
 pytest-mock~=3.0
-pytest-lazy-fixture~=0.6.3
+pytest-lazy-fixtures~=1.1.1
 pytest-cov~=5.0
 pytest-pretty~=1.2
 pytest-clarity~=1.0
 responses~=0.25.0
 requests-mock~=1.10
-types-pytest-lazy-fixture~=0.6.3

{python_semantic_release-9.8.6 → 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.6"
+__version__ = "9.8.8"
 
 __all__ = [
     "CommitParser",

{python_semantic_release-9.8.6 → python_semantic_release-9.8.8}/semantic_release/cli/changelog_writer.py

@@ -149,6 +149,7 @@ def generate_release_notes(
     hvcs_client: HvcsBase,
     release: Release,
     template_dir: Path,
+    history: ReleaseHistory,
 ) -> str:
     release_notes_env = ReleaseNotesContext(
         repo_name=hvcs_client.repo_name,
@@ -163,6 +164,11 @@ def generate_release_notes(
         environment(template_dir=template_dir)
     )
 
+    # TODO: Remove in v10
+    release_notes_env.globals["context"] = {
+        "history": history,
+    }
+
     return render_release_notes(
         release_notes_template=get_release_notes_template(template_dir),
         template_env=release_notes_env,

{python_semantic_release-9.8.6 → python_semantic_release-9.8.8}/semantic_release/cli/commands/changelog.py

@@ -34,7 +34,9 @@ def post_release_notes(
                 "\n",
                 [
                     f"would have posted the following release notes for tag {release_tag}:",
-                    release_notes,
+                    # Escape square brackets to ensure all content is displayed in the console
+                    # (i.e. prevent interpretation of ansi escape sequences that is valid markdown)
+                    release_notes.replace("[", "\\["),
                 ],
             )
         )
@@ -112,7 +114,8 @@ def changelog(cli_ctx: CliContextObj, release_tag: str | None) -> None:
     release_notes = generate_release_notes(
         hvcs_client,
         release,
-        template_dir=runtime.template_dir,
+        runtime.template_dir,
+        release_history,
     )
 
     try:

{python_semantic_release-9.8.6 → 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",
@@ -711,7 +711,8 @@ def version(  # noqa: C901
     release_notes = generate_release_notes(
         hvcs_client,
         release_history.released[new_version],
-        template_dir=runtime.template_dir,
+        runtime.template_dir,
+        history=release_history,
     )
 
     exception: Exception | None = None

{python_semantic_release-9.8.6 → 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.6 → python_semantic_release-9.8.8}/tests/command_line/test_changelog.py

@@ -3,14 +3,16 @@ from __future__ import annotations
 import filecmp
 import os
 import shutil
+import sys
 from typing import TYPE_CHECKING
 from unittest import mock
 
 import pytest
 import requests_mock
-from pytest_lazyfixture import lazy_fixture
+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