python-semantic-release · lilfetz22 · Dec 24, 2024 · Dec 24, 2024 · Dec 24, 2024 · Jan 10, 2026
diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md
@@ -255,6 +255,10 @@ and is not present in the default branch.
 [optional footer(s)]
 ```
 
+The header line (`<type>(<scope>): <summary>`) must not exceed **100 characters**.
+This limit is enforced by commitlint in CI and will cause the pipeline to fail.
+Always check the length of the header before committing.
+
 Scopes by the specification are optional but for this project, they are required and
 only by exception can they be omitted.
 
@@ -548,3 +552,7 @@ itself to perform the release steps. The release process includes:
   versioning. Make as few breaking changes as possible by adding backwards compatibility
   and if you do make a breaking change, be sure to include a detailed description in the
   `BREAKING CHANGE` footer of the commit message.
+
+- Never disable or bypass pre-commit hooks (e.g. do not use `git commit --no-verify`).
+  All hooks must remain active and pass before committing. If a hook is failing, fix the
+  underlying issue rather than skipping the check.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -2,7 +2,7 @@
 default_language_version:
   python: python3
 
-exclude: "^CHANGELOG.md$"
+exclude: "^CHANGELOG.rst$"
 
 repos:
   # Meta hooks
@@ -56,9 +56,22 @@ repos:
         additional_dependencies:
           - "pydantic>=2,<3"
           - "types-requests"
+          - "types-Deprecated"
+          - "types-pyyaml"
+          - "click~=8.1"
+          - "gitpython~=3.0"
+          - "jinja2~=3.1"
+          - "PyGithub~=2.0"
+          - "python-gitlab>=4.0.0,<7.0.0"
+          - "tomlkit~=0.13.0"
+          - "rich~=14.0"
+          - "shellingham~=1.5"
+          - "importlib-resources~=6.0"
+          - "click-option-group~=0.5"
         log_file: "mypy.log"
         files: "^(src|tests)/.*"
         pass_filenames: false
+        args: ["src"]
 
   - repo: https://github.com/pre-commit/pygrep-hooks
     rev: v1.10.0
@@ -80,8 +93,9 @@ repos:
           - --min-confidence
           - "100"
           - --sort-by-size
-          - "semantic_release"
+          - "src/semantic_release"
           - "tests"
+        pass_filenames: false
 
   - repo: https://github.com/pycqa/bandit
     rev: 1.7.8

diff --git a/docs/concepts/commit_parsing.rst b/docs/concepts/commit_parsing.rst
@@ -443,11 +443,12 @@ Common Issue Identifier Detection
 
 All of the PSR built-in parsers implement common issue identifier detection logic,
 which is similar to many VCS platforms such as GitHub, GitLab, and BitBucket. The
-parsers will look for common issue closure text prefixes in the `Git Trailer format`_
-in the commit message to identify and extract issue numbers. The detection logic is
-not strict to any specific issue tracker as we try to provide a flexible approach
-to identifying issue numbers but in order to be flexible, it is **required** to the
-use the `Git Trailer format`_ with a colon (``:``) as the token separator.
+parsers will look for common issue closure text prefixes in commit message footers
+to identify and extract issue numbers. The detection logic is not strict to any specific
+issue tracker as we try to provide a flexible approach to identifying issue numbers.
+PSR supports the `Git Trailer format`_ with a colon (``:``) as the token separator,
+as well as the more casual format without a colon (e.g., ``Closes #123`` or ``Closes: #123``)
+to match common VCS platform conventions.
 
 PSR attempts to support all variants of issue closure text prefixes, but not all will work
 for your VCS. PSR supports the following case-insensitive prefixes and their conjugations
@@ -466,13 +467,13 @@ the need of extra git trailers (although PSR does support multiple git trailers)
 various list formats which can be used to identify more than one issue in a list. This format
 will not necessarily work on your VCS. PSR currently support the following list formats:
 
-- comma-separated (ex. ``Closes: #123, #456, #789``)
-- space-separated (ex. ``resolve: #123 #456 #789``)
-- semicolon-separated (ex. ``Fixes: #123; #456; #789``)
-- slash-separated (ex. ``close: #123/#456/#789``)
-- ampersand-separated (ex. ``Implement: #123 & #789``)
-- and-separated (ex. ``Resolve: #123 and #456 and #789``)
-- mixed (ex. ``Closed: #123, #456, and #789`` or ``Fixes: #123, #456 & #789``)
+- comma-separated (ex. ``Closes #123, #456, #789`` or ``Closes: #123, #456, #789``)
+- space-separated (ex. ``resolve #123 #456 #789`` or ``resolve: #123 #456 #789``)
+- semicolon-separated (ex. ``Fixes #123; #456; #789`` or ``Fixes: #123; #456; #789``)
+- slash-separated (ex. ``close #123/#456/#789`` or ``close: #123/#456/#789``)
+- ampersand-separated (ex. ``Implement #123 & #789`` or ``Implement: #123 & #789``)
+- and-separated (ex. ``Resolve #123 and #456 and #789`` or ``Resolve: #123 and #456 and #789``)
+- mixed (ex. ``Closed #123, #456, and #789`` or ``Fixes #123, #456 & #789`` or with colons)
 
 All the examples above use the most common issue number prefix (``#``) but PSR is flexible
 to support other prefixes used by VCS platforms or issue trackers such as JIRA (ex. ``ABC-###``).

diff --git a/parse_errors.py b/parse_errors.py
@@ -0,0 +1,45 @@
+import xml.etree.ElementTree as ET  # noqa: S314   # safe use in offline parsing of test results
+
+
+def parse_failures() -> None:
+    # return type is None since this is a standalone utility
+
+    try:
+        tree = ET.parse("test_results.xml")  # noqa: S314
+        root = tree.getroot()
+
+        with open("test_results.txt", "w", encoding="utf-8") as f:
+            failure_count = 0
+
+            for testcase in root.iter("testcase"):
+                # Look for failure or error tags inside the testcase
+                failure = testcase.find("failure")
+                error = testcase.find("error")
+
+                issue = failure if failure is not None else error
+
+                if issue is not None:
+                    failure_count += 1
+                    file_path = testcase.get("file")
+                    test_name = testcase.get("name")
+                    error_msg = issue.get("message")
+                    # Get the detailed traceback text
+                    traceback = issue.text if issue.text else "No traceback available"
+
+                    f.write(f"--- FAILURE #{failure_count} ---\n")
+                    f.write(f"FILE: {file_path}\n")
+                    f.write(f"TEST: {test_name}\n")
+                    f.write(f"MESSAGE: {error_msg}\n")
+                    f.write(f"DETAILS:\n{traceback.strip()}\n")
+                    f.write("\n" + "=" * 40 + "\n\n")
+
+            print(f"Done! Found {failure_count} failures. Saved to 'test_results.txt'.")  # noqa: T201
+
+    except FileNotFoundError:
+        print("Error: Could not find 'test_results.xml'. Did the tests finish running?")  # noqa: T201
+    except Exception as e:  # noqa: BLE001,S314
+        print(f"An error occurred: {e}")  # noqa: T201
+
+
+if __name__ == "__main__":
+    parse_failures()
diff --git a/pyproject.toml b/pyproject.toml
@@ -32,6 +32,7 @@ dependencies = [
   "gitpython ~= 3.0",
   "requests ~= 2.25",
   "jinja2 ~= 3.1",
+  "PyGithub ~= 2.0",
   "python-gitlab >= 4.0.0, < 7.0.0",
   "tomlkit ~= 0.13.0",
   "dotty-dict ~= 1.3",
@@ -406,7 +407,7 @@ section-order = [
 sections = { "tests" = ["tests"] }
 
 [tool.vulture]
-ignore_names = ["change_to_ex_proj_dir", "init_example_project"]
+ignore_names = ["change_to_ex_proj_dir", "init_example_project", "pluginmanager", "base_repo_def", "init_example_monorepo"]
 
 [tool.semantic_release]
 add_partial_tags = true

diff --git a/src/semantic_release/changelog/context.py b/src/semantic_release/changelog/context.py
@@ -30,6 +30,7 @@ class ReleaseNotesContext:
     release: Release
     mask_initial_release: bool
     license_name: str
+    include_pypi_link: bool = False
     filters: tuple[Callable[..., Any], ...] = ()
 
     def bind_to_environment(self, env: Environment) -> Environment:

diff --git a/src/semantic_release/cli/changelog_writer.py b/src/semantic_release/cli/changelog_writer.py
@@ -230,6 +230,7 @@ def generate_release_notes(
     style: str,
     mask_initial_release: bool,
     license_name: str = "",
+    include_pypi_link: bool = False,
 ) -> str:
     users_tpl_file = template_dir / DEFAULT_RELEASE_NOTES_TPL_FILE
 
@@ -257,6 +258,7 @@ def generate_release_notes(
         release=release,
         mask_initial_release=mask_initial_release,
         license_name=license_name,
+        include_pypi_link=include_pypi_link,
         filters=(
             *hvcs_client.get_changelog_context_filters(),
             create_pypi_url,

diff --git a/src/semantic_release/cli/commands/generate_config.py b/src/semantic_release/cli/commands/generate_config.py
@@ -47,7 +47,12 @@ def generate_config(
     # due to possible IntEnum values (which are not supported by tomlkit.dumps, see sdispater/tomlkit#237),
     # we must ensure the transformation of the model to a dict uses json serializable values
     config_dct = {
-        "semantic_release": RawConfig().model_dump(mode="json", exclude_none=True)
+        "semantic_release": RawConfig().model_dump(
+            mode="json",
+            exclude_none=True,
+            # Drop deprecated changelog option to avoid emitting warnings in defaults
+            exclude={"changelog": {"changelog_file"}},
+        )
     }
 
     if is_pyproject_toml:

diff --git a/src/semantic_release/cli/commands/main.py b/src/semantic_release/cli/commands/main.py
@@ -4,7 +4,6 @@
 import logging
 from enum import Enum
 
-# from typing import TYPE_CHECKING
 import click
 from rich.console import Console
 from rich.logging import RichHandler
@@ -17,10 +16,6 @@
 from semantic_release.cli.util import rprint
 from semantic_release.enums import SemanticReleaseLogLevels
 
-# if TYPE_CHECKING:
-#     pass
-
-
 FORMAT = "%(message)s"
 LOG_LEVELS = [
     SemanticReleaseLogLevels.WARNING,
@@ -30,7 +25,7 @@
 ]
 
 
-class Cli(click.MultiCommand):
+class Cli(click.MultiCommand):  # type: ignore[misc, valid-type]
     """Root MultiCommand for the semantic-release CLI"""
 
     class SubCmds(Enum):