python-semantic-release 9.17.0__tar.gz → 9.18.1__tar.gz

{python_semantic_release-9.17.0/src/python_semantic_release.egg-info → python_semantic_release-9.18.1}/PKG-INFO

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

{python_semantic_release-9.17.0 → python_semantic_release-9.18.1}/docs/automatic-releases/github-actions.rst

@@ -337,7 +337,7 @@ before the :ref:`version <cmd-version>` subcommand.
 
   .. code:: yaml
 
-    - uses: python-semantic-release/python-semantic-release@v9.16.1
+    - uses: python-semantic-release/python-semantic-release@v9.18.0
       with:
         root_options: "-vv --noop"
 
@@ -576,7 +576,7 @@ before the :ref:`publish <cmd-publish>` subcommand.
 
   .. code:: yaml
 
-    - uses: python-semantic-release/publish-action@v9.16.1
+    - uses: python-semantic-release/publish-action@v9.18.0
       with:
         root_options: "-vv --noop"
 
@@ -684,7 +684,7 @@ to the GitHub Release Assets as well.
           - name: Action | Semantic Version Release
             id: release
             # Adjust tag with desired version if applicable.
-            uses: python-semantic-release/python-semantic-release@v9.16.1
+            uses: python-semantic-release/python-semantic-release@v9.18.0
             with:
               github_token: ${{ secrets.GITHUB_TOKEN }}
               git_committer_name: "github-actions"
@@ -695,7 +695,7 @@ to the GitHub Release Assets as well.
             if: steps.release.outputs.released == 'true'
 
           - name: Publish | Upload to GitHub Release Assets
-            uses: python-semantic-release/publish-action@v9.16.1
+            uses: python-semantic-release/publish-action@v9.18.0
             if: steps.release.outputs.released == 'true'
             with:
               github_token: ${{ secrets.GITHUB_TOKEN }}
@@ -744,7 +744,7 @@ The equivalent GitHub Action configuration would be:
 
   - name: Action | Semantic Version Release
     # Adjust tag with desired version if applicable.
-    uses: python-semantic-release/python-semantic-release@v9.16.1
+    uses: python-semantic-release/python-semantic-release@v9.18.0
     with:
       github_token: ${{ secrets.GITHUB_TOKEN }}
       force: patch
@@ -772,13 +772,13 @@ Publish Action.
 .. code:: yaml
 
    - name: Release Project 1
-     uses: python-semantic-release/python-semantic-release@v9.16.1
+     uses: python-semantic-release/python-semantic-release@v9.18.0
      with:
        directory: ./project1
        github_token: ${{ secrets.GITHUB_TOKEN }}
 
    - name: Release Project 2
-     uses: python-semantic-release/python-semantic-release@v9.16.1
+     uses: python-semantic-release/python-semantic-release@v9.18.0
      with:
        directory: ./project2
        github_token: ${{ secrets.GITHUB_TOKEN }}

{python_semantic_release-9.17.0 → python_semantic_release-9.18.1}/docs/changelog_templates.rst

@@ -246,6 +246,11 @@ Configuration Examples
           '''Merged? .*''',
         ]
 
+If identified or supported by the parser, the default changelog templates will include
+a separate section of breaking changes and additional release information. Refer to the
+:ref:`commit parsing <commit-parsing>` section to see how to write commit messages that
+will be properly parsed and displayed in these sections.
+
 
 .. _changelog-templates-default_release_notes:
 
@@ -260,16 +265,37 @@ default built-in template out-of-the-box for generating release notes.
 
 The difference between the changelog and release notes is that the release notes
 only contain the changes for the current release. Due to the modularity of the
-PSR templates, the format is identical to an individual version of the default
-changelog.
+PSR templates, the format is similar to an individual version of the default
+changelog but may include other version specific information.
 
 At this time, the default template for version release notes is only available
 in Markdown format for all VCS types.
 
+If you want to review what the default release notes look like you can use the
+following command to print the release notes to the console (remove any configuration
+for defining a custom template directory):
+
+.. code:: console
+
+    # Create a current tag
+    git tag v1.0.0
+    semantic-release --noop changelog --post-to-release-tag v1.0.0
+
+The default template provided by PSR will respect the
+:ref:`<config-changelog-default_templates-mask_initial_release>` setting and
+will also add a comparison link to the previous release if one exists without
+customization.
+
+As of ``v9.18.0``, the default release notes will also include a statement to
+declare which license the project was released under. PSR determines which license
+to declare based on the value of ``project.license-expression`` in the ``pyproject.toml``
+file as defined in the `PEP 639`_ specification.
+
 .. seealso::
     - To personalize your release notes, see the
       :ref:`changelog-templates-custom_release_notes` section.
 
+.. _PEP 639: https://peps.python.org/pep-0639/
 
 .. _changelog-templates-template-rendering:
 
@@ -658,6 +684,45 @@ The filters provided vary based on the VCS configured and available features:
           )
       }}
 
+* ``create_pypi_url(package_name: str, version: str = "")``: given a package name and an optional
+  version, return a URL to the PyPI page for the package. If a version is provided, the URL will
+  point to the specific version page. If no version is provided, the URL will point to the package
+  page.
+
+  *Introduced in v9.18.0.*
+
+  **Example Usage:**
+
+  .. code:: jinja
+
+      {{ "example-package" | create_pypi_url }}
+      {{ "example-package" | create_pypi_url("1.0.0") }}
+
+  **Markdown Output:**
+
+  .. code:: markdown
+
+      https://pypi.org/project/example-package
+      https://pypi.org/project/example-package/1.0.0
+
+* ``create_release_url (Callable[[TagStr], UrlStr])``: given a tag, return a URL to the release
+  page on the remote vcs. This filter is useful when you want to link to the release page on the
+  remote vcs.
+
+  *Introduced in v9.18.0.*
+
+  **Example Usage:**
+
+  .. code:: jinja
+
+      {{ "v1.0.0" | create_release_url }}
+
+  **Markdown Output:**
+
+  .. code:: markdown
+
+      https://example.com/example/repo/releases/tag/v1.0.0
+
 * ``create_server_url (Callable[[PathStr, AuthStr | None, QueryStr | None, FragmentStr | None], UrlStr])``:
   when given a path, prepend the configured vcs server host and url scheme.  Optionally you
   can provide, a auth string, a query string or a url fragment to be normalized into the
@@ -817,6 +882,29 @@ The filters provided vary based on the VCS configured and available features:
 
       [#29](https://example.com/example/repo/pull/29)
 
+* ``format_w_official_vcs_name (Callable[[str], str])``: given a format string, insert
+  the official VCS type name into the string and return. This filter is useful when you want to
+  display the proper name of the VCS type in a changelog or release notes. The filter supports
+  three different replace formats: ``%s``, ``{}``, and ``{vcs_name}``.
+
+  *Introduced in v9.18.0.*
+
+  **Example Usage:**
+
+  .. code:: jinja
+
+      {{ "%s Releases" | format_w_official_vcs_name }}
+      {{ "{} Releases" | format_w_official_vcs_name }}
+      {{ "{vcs_name} Releases" | format_w_official_vcs_name }}
+
+  **Markdown Output:**
+
+  .. code:: markdown
+
+      GitHub Releases
+      GitHub Releases
+      GitHub Releases
+
 * ``read_file (Callable[[str], str])``: given a file path, read the file and
   return the contents as a string. This function was added specifically to
   enable the changelog update feature where it would load the existing changelog
@@ -858,21 +946,24 @@ The filters provided vary based on the VCS configured and available features:
 
 Availability of the documented filters can be found in the table below:
 
-======================  =========  =====  ======  ======
-**filter - hvcs_type**  bitbucket  gitea  github  gitlab
-======================  =========  =====  ======  ======
-autofit_text_width         ✅       ✅      ✅      ✅
-convert_md_to_rst          ✅       ✅      ✅      ✅
-create_server_url          ✅       ✅      ✅      ✅
-create_repo_url            ✅       ✅      ✅      ✅
-commit_hash_url            ✅       ✅      ✅      ✅
-compare_url                ✅       ❌      ✅      ✅
-issue_url                  ❌       ✅      ✅      ✅
-merge_request_url          ❌       ❌      ❌      ✅
-pull_request_url           ✅       ✅      ✅      ✅
-read_file                  ✅       ✅      ✅      ✅
-sort_numerically           ✅       ✅      ✅      ✅
-======================  =========  =====  ======  ======
+==========================  =========  =====  ======  ======
+**filter - hvcs_type**      bitbucket  gitea  github  gitlab
+==========================  =========  =====  ======  ======
+autofit_text_width             ✅       ✅      ✅      ✅
+convert_md_to_rst              ✅       ✅      ✅      ✅
+create_pypi_url                ✅       ✅      ✅      ✅
+create_server_url              ✅       ✅      ✅      ✅
+create_release_url             ❌       ✅      ✅      ✅
+create_repo_url                ✅       ✅      ✅      ✅
+commit_hash_url                ✅       ✅      ✅      ✅
+compare_url                    ✅       ❌      ✅      ✅
+format_w_official_vcs_name     ✅       ✅      ✅      ✅
+issue_url                      ❌       ✅      ✅      ✅
+merge_request_url              ❌       ❌      ❌      ✅
+pull_request_url               ✅       ✅      ✅      ✅
+read_file                      ✅       ✅      ✅      ✅
+sort_numerically               ✅       ✅      ✅      ✅
+==========================  =========  =====  ======  ======
 
 .. seealso::
    * `Filters <https://jinja.palletsprojects.com/en/3.1.x/templates/#filters>`_

{python_semantic_release-9.17.0 → python_semantic_release-9.18.1}/docs/commit_parsing.rst

@@ -114,6 +114,12 @@ logic in relation to how PSR's core features:
   feature on/off via the :ref:`config-commit_parser_options` setting. *Feature available in
   v9.17.0+.*
 
+- **Release Notice Footer Detection**: This parser implements PSR's
+  :ref:`commit_parser-builtin-release_notice_footer_detection`, which is a custom extension
+  to traditional `Angular Commit Style Guidelines`_ to use the ``NOTICE`` keyword as a git
+  footer to document additional release information that is not considered a breaking change.
+  *Feature available in v9.18.0+.*
+
 **Limitations**:
 
 - Commits with the ``revert`` type are not currently supported. Track the implementation
@@ -185,6 +191,11 @@ how PSR's core features:
   feature on/off via the :ref:`config-commit_parser_options` setting. *Feature available in
   v9.17.0+.*
 
+- **Release Notice Footer Detection**: This parser implements PSR's
+  :ref:`commit_parser-builtin-release_notice_footer_detection`, which is a custom extension
+  that uses the ``NOTICE`` keyword as a git footer to document additional release information
+  that is not considered a breaking change. *Feature available in v9.18.0+.*
+
 If no commit parser options are provided via the configuration, the parser will use PSR's
 built-in :py:class:`defaults <semantic_release.commit_parser.emoji.EmojiParserOptions>`.
 
@@ -310,6 +321,33 @@ return an empty tuple.
 
 ----
 
+.. _commit_parser-builtin-release_notice_footer_detection:
+
+Common Release Notice Footer Detection
+""""""""""""""""""""""""""""""""""""""
+
+*Introduced in v9.18.0**
+
+All of the PSR built-in parsers implement common release notice footer detection logic
+to identify and extract a ``NOTICE`` git trailer that documents any additional release
+information the developer wants to provide to the software consumer. The idea extends
+from the concept of the ``BREAKING CHANGE:`` git trailer to document any breaking change
+descriptions but the ``NOTICE`` trailer is intended to document any information that is
+below the threshold of a breaking change while still important for the software consumer
+to be aware of. Common uses would be to provide deprecation warnings or more detailed
+change usage information for that release. Parsers will collapse single newlines after
+the ``NOTICE`` trailer into a single line paragraph. Commits may have more than one
+``NOTICE`` trailer in a single commit message. Each
+:py:class:`ParsedCommit <semantic_release.commit_parser.token.ParsedCommit>` will have
+a ``release_notices`` attribute that is a tuple of string paragraphs to identify each
+release notice.
+
+In the default changelog and release notes template, these release notices will be
+formatted into their own section called **ADDITIONAL RELEASE INFORMATION**. Each will
+include any commit scope defined and each release notice in alphabetical order.
+
+----
+
 .. _commit_parser-builtin-squash_commit_evaluation:
 
 Common Squash Commit Evaluation

{python_semantic_release-9.17.0 → python_semantic_release-9.18.1}/docs/index.rst

@@ -69,6 +69,7 @@ Documentation Contents
    Migrating from Python Semantic Release v7 <migrating_from_v7>
    Internal API <api/modules>
    Algorithm <algorithm>
+   Changelog <psr_changelog>
    View on GitHub <https://github.com/python-semantic-release/python-semantic-release>
 
 Getting Started

python_semantic_release-9.18.1/docs/psr_changelog.rst

@@ -0,0 +1 @@
+.. include:: ../CHANGELOG.rst

{python_semantic_release-9.17.0 → python_semantic_release-9.18.1}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-semantic-release"
-version = "9.17.0"
+version = "9.18.1"
 description = "Automatic Semantic Versioning for Python projects"
 requires-python = ">=3.8"
 license = { text = "MIT" }
@@ -399,6 +399,7 @@ ignore_names = ["change_to_ex_proj_dir", "init_example_project"]
 [tool.semantic_release]
 logging_use_named_masks = true
 commit_parser = "angular"
+commit_parser_options = { parse_squash_commits = true, ignore_merge_commits = true }
 build_command = """
     python -m pip install -e .[build]
     python -m build .
@@ -408,6 +409,7 @@ version_variables = ["src/semantic_release/__init__.py:__version__"]
 version_toml = ["pyproject.toml:project.version"]
 
 [tool.semantic_release.changelog]
+# default_templates = { changelog_file = "CHANGELOG.rst" }
 exclude_commit_patterns = [
   '''chore(?:\([^)]*?\))?: .+''',
   '''ci(?:\([^)]*?\))?: .+''',
@@ -420,6 +422,9 @@ exclude_commit_patterns = [
   # Old semantic-release version commits
   '''^\d+\.\d+\.\d+''',
 ]
+insertion_flag = "=========\nCHANGELOG\n========="
+mode = "update"
+template_dir = "config/release-templates"
 
 [tool.semantic_release.branches.main]
 match = "(main|master)"

{python_semantic_release-9.17.0 → python_semantic_release-9.18.1/src/python_semantic_release.egg-info}/PKG-INFO

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

{python_semantic_release-9.17.0 → python_semantic_release-9.18.1}/src/python_semantic_release.egg-info/SOURCES.txt

@@ -16,6 +16,7 @@ docs/index.rst
 docs/make.bat
 docs/migrating_from_v7.rst
 docs/multibranch_releases.rst
+docs/psr_changelog.rst
 docs/strict_mode.rst
 docs/troubleshooting.rst
 docs/automatic-releases/cronjobs.rst
@@ -107,6 +108,8 @@ tests/e2e/test_main.py
 tests/e2e/cmd_changelog/__init__.py
 tests/e2e/cmd_changelog/test_changelog.py
 tests/e2e/cmd_changelog/test_changelog_custom_parser.py
+tests/e2e/cmd_changelog/test_changelog_parsing.py
+tests/e2e/cmd_changelog/test_changelog_release_notes.py
 tests/e2e/cmd_config/__init__.py
 tests/e2e/cmd_config/test_generate_config.py
 tests/e2e/cmd_publish/__init__.py

{python_semantic_release-9.17.0 → python_semantic_release-9.18.1}/src/semantic_release/__init__.py

@@ -24,7 +24,7 @@ from semantic_release.version import (
     tags_and_versions,
 )
 
-__version__ = "9.17.0"
+__version__ = "9.18.1"
 
 __all__ = [
     "CommitParser",

{python_semantic_release-9.17.0 → python_semantic_release-9.18.1}/src/semantic_release/changelog/context.py

@@ -4,10 +4,13 @@ import logging
 import os
 from dataclasses import dataclass
 from enum import Enum
-from pathlib import Path
+from pathlib import Path, PurePosixPath
 from re import compile as regexp
 from typing import TYPE_CHECKING, Any, Callable, Literal
 
+from urllib3.util import Url
+
+from semantic_release.const import PYPI_WEB_DOMAIN
 from semantic_release.helpers import sort_numerically
 
 if TYPE_CHECKING:  # pragma: no cover
@@ -26,6 +29,7 @@ class ReleaseNotesContext:
     version: Version
     release: Release
     mask_initial_release: bool
+    license_name: str
     filters: tuple[Callable[..., Any], ...] = ()
 
     def bind_to_environment(self, env: Environment) -> Environment:
@@ -86,6 +90,7 @@ def make_changelog_context(
         hvcs_type=hvcs_client.__class__.__name__.lower(),
         filters=(
             *hvcs_client.get_changelog_context_filters(),
+            create_pypi_url,
             read_file,
             convert_md_to_rst,
             autofit_text_width,
@@ -94,6 +99,17 @@ def make_changelog_context(
     )
 
 
+def create_pypi_url(package_name: str, version: str = "") -> str:
+    project_name = package_name.strip("/").strip()
+    if not project_name:
+        raise ValueError("package_name must not be empty!")
+    return Url(
+        scheme="https",
+        host=PYPI_WEB_DOMAIN,
+        path=str(PurePosixPath("project", project_name, version.strip("/").strip())),
+    ).url.rstrip("/")
+
+
 def read_file(filepath: str) -> str:
     try:
         if not filepath:

{python_semantic_release-9.17.0 → python_semantic_release-9.18.1}/src/semantic_release/changelog/release_history.py

@@ -9,7 +9,9 @@ from git.objects.tag import TagObject
 
 from semantic_release.commit_parser import ParseError
 from semantic_release.commit_parser.token import ParsedCommit
+from semantic_release.commit_parser.util import force_str
 from semantic_release.enums import LevelBump
+from semantic_release.helpers import validate_types_in_sequence
 from semantic_release.version.algorithm import tags_and_versions
 
 if TYPE_CHECKING:  # pragma: no cover
@@ -50,6 +52,12 @@ class ReleaseHistory:
             for tag, version in all_git_tags_and_versions
         }
 
+        ignore_merge_commits = bool(
+            hasattr(commit_parser, "options")
+            and hasattr(commit_parser.options, "ignore_merge_commits")
+            and getattr(commit_parser.options, "ignore_merge_commits")  # noqa: B009
+        )
+
         # Strategy:
         # Loop through commits in history, parsing as we go.
         # Add these commits to `unreleased` as a key-value mapping
@@ -110,14 +118,36 @@ class ReleaseHistory:
             # returns a ParseResult or list of ParseResult objects,
             # it is usually one, but we split a commit if a squashed merge is detected
             parse_results = commit_parser.parse(commit)
-            if not isinstance(parse_results, list):
-                parse_results = [parse_results]
 
-            is_squash_commit = bool(len(parse_results) > 1)
+            if not any(
+                (
+                    isinstance(parse_results, (ParseError, ParsedCommit)),
+                    (
+                        (
+                            isinstance(parse_results, list)
+                            or type(parse_results) == tuple
+                        )
+                        and validate_types_in_sequence(
+                            parse_results, (ParseError, ParsedCommit)
+                        )
+                    ),
+                )
+            ):
+                raise TypeError("Unexpected type returned from commit_parser.parse")
+
+            results: list[ParseResult] = [
+                *(
+                    [parse_results]
+                    if isinstance(parse_results, (ParseError, ParsedCommit))
+                    else parse_results
+                ),
+            ]
+
+            is_squash_commit = bool(len(results) > 1)
 
             # iterate through parsed commits to add to changelog definition
-            for parsed_result in parse_results:
-                commit_message = str(parsed_result.commit.message)
+            for parsed_result in results:
+                commit_message = force_str(parsed_result.commit.message)
                 commit_type = (
                     "unknown"
                     if isinstance(parsed_result, ParseError)
@@ -135,6 +165,10 @@ class ReleaseHistory:
                     else parsed_result.bump
                 )
 
+                if ignore_merge_commits and parsed_result.is_merge_commit():
+                    log.info("Excluding merge commit[%s]", parsed_result.short_hash)
+                    continue
+
                 # Skip excluded commits except for any commit causing a version bump
                 # Reasoning: if a commit causes a version bump, and no other commits
                 # are included, then the changelog will be empty. Even if ther was other

{python_semantic_release-9.17.0 → python_semantic_release-9.18.1}/src/semantic_release/cli/changelog_writer.py

@@ -13,6 +13,7 @@ import semantic_release
 from semantic_release.changelog.context import (
     ReleaseNotesContext,
     autofit_text_width,
+    create_pypi_url,
     make_changelog_context,
 )
 from semantic_release.changelog.template import environment, recursive_render
@@ -229,6 +230,7 @@ def generate_release_notes(
     history: ReleaseHistory,
     style: str,
     mask_initial_release: bool,
+    license_name: str = "",
 ) -> str:
     users_tpl_file = template_dir / DEFAULT_RELEASE_NOTES_TPL_FILE
 
@@ -255,8 +257,10 @@ def generate_release_notes(
         version=release["version"],
         release=release,
         mask_initial_release=mask_initial_release,
+        license_name=license_name,
         filters=(
             *hvcs_client.get_changelog_context_filters(),
+            create_pypi_url,
             autofit_text_width,
             sort_numerically,
         ),

{python_semantic_release-9.17.0 → python_semantic_release-9.18.1}/src/semantic_release/cli/commands/changelog.py

@@ -1,10 +1,13 @@
 from __future__ import annotations
 
 import logging
+from contextlib import suppress
+from pathlib import Path
 from typing import TYPE_CHECKING
 
 import click
-from git import Repo
+import tomlkit
+from git import GitCommandError, Repo
 
 from semantic_release.changelog.release_history import ReleaseHistory
 from semantic_release.cli.changelog_writer import (
@@ -21,6 +24,43 @@ if TYPE_CHECKING:  # pragma: no cover
 log = logging.getLogger(__name__)
 
 
+def get_license_name_for_release(tag_name: str, project_root: Path) -> str:
+    # Retrieve the license name at the time of the specific release tag
+    project_metadata: dict[str, str] = {}
+    curr_dir = Path.cwd().resolve()
+    allowed_directories = [
+        dir_path
+        for dir_path in [curr_dir, *curr_dir.parents]
+        if str(project_root) in str(dir_path)
+    ]
+    for allowed_dir in allowed_directories:
+        proj_toml = allowed_dir.joinpath("pyproject.toml")
+        with Repo(project_root) as git_repo, suppress(GitCommandError):
+            toml_contents = git_repo.git.show(
+                f"{tag_name}:{proj_toml.relative_to(project_root)}"
+            )
+            config_toml = tomlkit.parse(toml_contents)
+            project_metadata = config_toml.unwrap().get("project", project_metadata)
+            break
+
+    license_cfg = project_metadata.get(
+        "license-expression",
+        project_metadata.get(
+            "license",
+            "",
+        ),
+    )
+
+    if not isinstance(license_cfg, (str, dict)) or license_cfg is None:
+        return ""
+
+    return (
+        license_cfg.get("text", "")  # type: ignore[attr-defined]
+        if isinstance(license_cfg, dict)
+        else license_cfg or ""
+    )
+
+
 def post_release_notes(
     release_tag: str,
     release_notes: str,
@@ -120,6 +160,10 @@ def changelog(cli_ctx: CliContextObj, release_tag: str | None) -> None:
         release_history,
         style=runtime.changelog_style,
         mask_initial_release=runtime.changelog_mask_initial_release,
+        license_name=get_license_name_for_release(
+            tag_name=release_tag,
+            project_root=runtime.repo_dir,
+        ),
     )
 
     try:

{python_semantic_release-9.17.0 → python_semantic_release-9.18.1}/src/semantic_release/cli/commands/version.py

@@ -699,13 +699,31 @@ def version(  # noqa: C901
         log.info("Remote does not support releases. Skipping release creation...")
         return
 
+    license_cfg = runtime.project_metadata.get(
+        "license-expression",
+        runtime.project_metadata.get(
+            "license",
+            "",
+        ),
+    )
+
+    if not isinstance(license_cfg, (str, dict)) or license_cfg is None:
+        license_cfg = ""
+
+    license_name = (
+        license_cfg.get("text", "")
+        if isinstance(license_cfg, dict)
+        else license_cfg or ""
+    )
+
     release_notes = generate_release_notes(
         hvcs_client,
-        release_history.released[new_version],
-        runtime.template_dir,
+        release=release_history.released[new_version],
+        template_dir=runtime.template_dir,
         history=release_history,
         style=runtime.changelog_style,
         mask_initial_release=runtime.changelog_mask_initial_release,
+        license_name=license_name,
     )
 
     exception: Exception | None = None