[pull] master from python-semantic-release:master

.github/workflows/main.yml

@@ -52,7 +52,7 @@ jobs:
             --junit-xml=tests/reports/pytest-results.xml
 
       - name: Report | Upload Test Results
-        uses: mikepenz/action-junit-report@v4.2.2
+        uses: mikepenz/action-junit-report@v4.3.1
         if: ${{ always() && steps.tests.outcome != 'skipped' }}
         with:
           report_paths: ./tests/reports/*.xml

.github/workflows/pr.yml

@@ -49,7 +49,7 @@ jobs:
             --junit-xml=tests/reports/pytest-results.xml
 
       - name: Report | Upload Test Results
-        uses: mikepenz/action-junit-report@v4.2.2
+        uses: mikepenz/action-junit-report@v4.3.1
         if: ${{ always() && steps.tests.outcome != 'skipped' }}
         with:
           report_paths: ./tests/reports/*.xml

.pre-commit-config.yaml

@@ -29,12 +29,6 @@ repos:
       - id: mixed-line-ending
       - id: check-ast
 
-  - repo: https://github.com/adamchainz/blacken-docs
-    rev: 1.16.0
-    hooks:
-      - id: blacken-docs
-        additional_dependencies: ["black==23.10.1"]
-
   - repo: https://github.com/asottile/pyupgrade
     rev: v3.16.0
     hooks:
@@ -43,7 +37,7 @@ repos:
 
   # Linters and validation
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.4.9
+    rev: v0.5.0
     hooks:
       - id: ruff
         name: ruff (lint)
@@ -71,7 +65,6 @@ repos:
     hooks:
       # - id: python-use-type-annotations
       - id: python-check-blanket-noqa
-      - id: python-check-blanket-type-ignore
       - id: python-check-mock-methods
       - id: python-no-eval
       - id: python-no-log-warn

CHANGELOG.md

@@ -1,5 +1,29 @@
 # CHANGELOG
 
+## v9.8.4 (2024-07-04)
+
+### Fix
+
+* fix(changelog-cmd): remove usage strings when error occured
+
+Resolves: #810 ([`348a51d`](https://github.com/python-semantic-release/python-semantic-release/commit/348a51db8a837d951966aff3789aa0c93d473829))
+
+* fix(publish-cmd): remove usage strings when error occured
+
+Resolves: #810 ([`afbb187`](https://github.com/python-semantic-release/python-semantic-release/commit/afbb187d6d405fdf6765082e2a1cecdcd7d357df))
+
+* fix(config): prevent path traversal manipulation of target changelog location ([`43e35d0`](https://github.com/python-semantic-release/python-semantic-release/commit/43e35d0972e8a29239d18ed079d1e2013342fcbd))
+
+* fix(version-cmd): remove usage strings when error occurred
+
+Resolves: #810 ([`a7c17c7`](https://github.com/python-semantic-release/python-semantic-release/commit/a7c17c73fd7becb6d0e042e45ff6765605187e2a))
+
+* fix(publish-cmd): prevent error when provided tag does not exist locally ([`16afbbb`](https://github.com/python-semantic-release/python-semantic-release/commit/16afbbb8fbc3a97243e96d7573f4ad2eba09aab9))
+
+* fix(config): prevent path traversal manipulation of target changelog location ([`3eb3dba`](https://github.com/python-semantic-release/python-semantic-release/commit/3eb3dbafec4223ee463b90e927e551639c69426b))
+
+* fix(changelog-cmd): render default changelog when user template directory exist but is empty ([`bded8de`](https://github.com/python-semantic-release/python-semantic-release/commit/bded8deae6c92f6dde9774802d9f3716a5cb5705))
+
 ## v9.8.3 (2024-06-18)
 
 ### Fix

pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-semantic-release"
-version = "9.8.3"
+version = "9.8.4"
 description = "Automatic Semantic Versioning for Python projects"
 requires-python = ">=3.8"
 license = { text = "MIT" }
@@ -37,8 +37,8 @@ dependencies = [
 ]
 
 [project.scripts]
-semantic-release = "semantic_release.cli:main"
-psr = "semantic_release.cli:main"
+semantic-release = "semantic_release.cli.commands.main:main"
+psr = "semantic_release.cli.commands.main:main"
 
 [project.urls]
 changelog = "https://github.com/python-semantic-release/python-semantic-release/blob/master/CHANGELOG.md"
@@ -74,11 +74,11 @@ test = [
 dev = [
   "pre-commit ~= 3.5",
   "tox ~= 4.11",
-  "ruff == 0.4.9"
+  "ruff == 0.5.0"
 ]
 mypy = [
-  "mypy == 1.10.0",
-  "types-requests ~= 2.31.0"
+  "mypy == 1.10.1",
+  "types-requests ~= 2.32.0",
 ]
 
 [tool.pytest.ini_options]
@@ -156,6 +156,7 @@ show_error_context = true
 pretty = true
 error_summary = true
 follow_imports = "normal"
+enable_error_code = ["ignore-without-code"]
 ignore_missing_imports = true   # gitpython is very dynamic
 disallow_untyped_calls = true
 # warn_return_any = true
@@ -236,6 +237,8 @@ ignore = [
   "INP001",
   # Errors should end with "Error"
   "N818",
+  # mypy prevents blanket-type-ignore
+  "PGH003",
   # Fixtures that do not return a value need an underscore prefix.  The rule
   # does not handle generators.
   "PT004",
@@ -287,9 +290,10 @@ external = ["V"]
 task-tags = ["NOTE", "TODO", "FIXME", "XXX"]
 
 [tool.ruff.format]
-quote-style = "double"
+docstring-code-format = true
 indent-style = "space"
 line-ending = "lf"
+quote-style = "double"
 
 [tool.ruff.lint.per-file-ignores]
 # Imported but unused

semantic_release/__init__.py

@@ -24,7 +24,25 @@
     tags_and_versions,
 )
 
-__version__ = "9.8.3"
+__version__ = "9.8.4"
+
+__all__ = [
+    "CommitParser",
+    "ParsedCommit",
+    "ParseError",
+    "ParseResult",
+    "ParseResultType",
+    "ParserOptions",
+    "LevelBump",
+    "SemanticReleaseBaseError",
+    "CommitParseError",
+    "InvalidConfiguration",
+    "InvalidVersion",
+    "Version",
+    "VersionTranslator",
+    "next_version",
+    "tags_and_versions",
+]
 
 
 def setup_hook(argv: list[str]) -> None:
@@ -36,6 +54,6 @@ def setup_hook(argv: list[str]) -> None:
     if len(argv) > 1 and any(
         cmd in argv for cmd in ["version", "publish", "changelog"]
     ):
-        from semantic_release.cli import main
+        from semantic_release.cli.commands.main import main
 
         main()

semantic_release/__main__.py

@@ -1,6 +1,6 @@
 import sys
 
-from semantic_release.cli import main
+from semantic_release.cli.commands.main import main
 
 if __name__ == "__main__":
     main(args=sys.argv[1:])

semantic_release/changelog/context.py

@@ -6,8 +6,32 @@
 if TYPE_CHECKING:
     from jinja2 import Environment
 
-    from semantic_release.changelog.release_history import ReleaseHistory
+    from semantic_release.changelog.release_history import Release, ReleaseHistory
     from semantic_release.hvcs._base import HvcsBase
+    from semantic_release.version.version import Version
+
+
+@dataclass
+class ReleaseNotesContext:
+    repo_name: str
+    repo_owner: str
+    hvcs_type: str
+    version: Version
+    release: Release
+    filters: tuple[Callable[..., Any], ...] = ()
+
+    def bind_to_environment(self, env: Environment) -> Environment:
+        env_globals = dict(
+            filter(lambda k_v: k_v[0] != "filters", self.__dict__.items())
+        )
+
+        for g, v in env_globals.items():
+            env.globals[g] = v
+
+        for f in self.filters:
+            env.filters[f.__name__] = f
+
+        return env
 
 
 @dataclass

semantic_release/changelog/release_history.py

@@ -99,6 +99,7 @@ def from_git_history(
                         committer=committer,
                         tagged_date=tagged_date,
                         elements=defaultdict(list),
+                        version=the_version,
                     )
 
                     released.setdefault(the_version, release)
@@ -165,6 +166,7 @@ def release(
                     "committer": committer,
                     "tagged_date": tagged_date,
                     "elements": self.unreleased,
+                    "version": version,
                 },
                 **self.released,
             },
@@ -183,3 +185,4 @@ class Release(TypedDict):
     committer: Actor
     tagged_date: datetime
     elements: dict[str, list[ParseResult]]
+    version: Version

semantic_release/cli/__init__.py

@@ -1,10 +0,0 @@
-from semantic_release.cli.commands.changelog import changelog
-from semantic_release.cli.commands.generate_config import generate_config
-from semantic_release.cli.commands.main import main
-from semantic_release.cli.commands.publish import publish
-from semantic_release.cli.commands.version import version
-
-main.add_command(changelog)
-main.add_command(generate_config)
-main.add_command(version)
-main.add_command(publish)