feat(release-notes): add license information to default release notes template (#1167)

Adds a one-line notice to the version release notes about the current license
the version is released under at that time.

Resolves: #228

* test(release-notes): update unit tests to include license statement

* test(fixtures): add release notes generator fixture from repo definition

* test(cmd-version): add test to evaluate release notes generation w/ license statement

* test(cmd-changelog): add test to evaluate release notes generation w/ license statement

* docs(changelog-templates): add details about license specification in the release notes

* refactor(changelog-templates): simplify markdown template processing

* refactor(changelog-templates): simplify reStructuredText template processing

* chore(release-notes): add license information to each version release for psr

Author: codejedi365

config/release-templates/.components/versioned_changes.md.j2

@@ -2,14 +2,19 @@
 
 ## vX.X.X (YYYY-MMM-DD)
 
+_This release is published under the MIT License._            # Release Notes Only
+
 {{ change_sections }}
 
 #}{{
 "## %s (%s)\n" | format(
   release.version.as_semver_tag(),
   release.tagged_date.strftime("%Y-%m-%d")
 )
-}}{#
+}}{%  if license_name is defined and license_name
+%}{{    "\n_This release is published under the %s License._\n" | format(license_name)
+}}{%  endif
+%}{#
 #}{%  set commit_objects = release["elements"]
 %}{%  include "changes.md.j2"
 -%}

config/release-templates/.release_notes.md.j2

@@ -3,6 +3,8 @@
 
 ## v1.0.0 (2020-01-01)
 
+_This release is published under the MIT License._
+
 ### ✨ Features
 
 - Add new feature ([PR#10](https://domain.com/namespace/repo/pull/10), [`abcdef0`](https://domain.com/namespace/repo/commit/HASH))
@@ -43,6 +45,7 @@
 #}{#  # Set line width to 1000 to avoid wrapping as GitHub will handle it
 #}{%  set max_line_width = max_line_width | default(1000)
 %}{%  set hanging_indent = hanging_indent | default(2)
+%}{%  set license_name = license_name | default("", True)
 %}{%  set releases = context.history.released.values() | list
 %}{%  set curr_release_index = releases.index(release)
 %}{#

docs/changelog_templates.rst

@@ -286,10 +286,16 @@ The default template provided by PSR will respect the
 will also add a comparison link to the previous release if one exists without
 customization.
 
+As of ``${NEW_RELEASE_TAG}``, 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:
 

src/semantic_release/changelog/context.py

@@ -29,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:

src/semantic_release/cli/changelog_writer.py

@@ -230,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
 
@@ -256,6 +257,7 @@ 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,

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 @@
 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:

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

src/semantic_release/cli/config.py

@@ -15,6 +15,8 @@
 )
 from typing import Any, ClassVar, Dict, List, Literal, Optional, Tuple, Type, Union
 
+# typing_extensions is for Python 3.8, 3.9, 3.10 compatibility
+import tomlkit
 from git import Actor, InvalidGitRepositoryError
 from git.repo.base import Repo
 from jinja2 import Environment
@@ -26,8 +28,6 @@
     field_validator,
     model_validator,
 )
-
-# typing_extensions is for Python 3.8, 3.9, 3.10 compatibility
 from typing_extensions import Annotated, Self
 from urllib3.util.url import parse_url
 
@@ -523,6 +523,7 @@ def _recursive_getattr(obj: Any, path: str) -> Any:
 class RuntimeContext:
     _mask_attrs_: ClassVar[List[str]] = ["hvcs_client.token"]
 
+    project_metadata: dict[str, Any]
     repo_dir: Path
     commit_parser: CommitParser[ParseResult, ParserOptions]
     version_translator: VersionTranslator
@@ -599,6 +600,21 @@ def from_raw_config(  # noqa: C901
         # credentials masking for logging
         masker = MaskingFilter(_use_named_masks=raw.logging_use_named_masks)
 
+        # TODO: move to config if we change how the generated config is constructed
+        # Retrieve project metadata from pyproject.toml
+        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(raw.repo_dir) in str(dir_path)
+        ]
+        for allowed_dir in allowed_directories:
+            if (proj_toml := allowed_dir.joinpath("pyproject.toml")).exists():
+                config_toml = tomlkit.parse(proj_toml.read_text())
+                project_metadata = config_toml.unwrap().get("project", project_metadata)
+                break
+
         # Retrieve details from repository
         with Repo(str(raw.repo_dir)) as git_repo:
             try:
@@ -825,6 +841,7 @@ def from_raw_config(  # noqa: C901
         # )
 
         self = cls(
+            project_metadata=project_metadata,
             repo_dir=raw.repo_dir,
             commit_parser=commit_parser,
             version_translator=version_translator,

src/semantic_release/data/templates/angular/md/.components/changes.md.j2

@@ -41,8 +41,8 @@ EXAMPLE:
 #}{%  for type_, commits in commit_objects if type_ != "unknown"
 %}{#    PREPROCESS COMMITS (order by description & format description line)
 #}{%    set ns = namespace(commits=commits)
-%}{{    apply_alphabetical_ordering_by_descriptions(ns) | default("", true)
-}}{#
+%}{%    set _ = apply_alphabetical_ordering_by_descriptions(ns)
+%}{#
 #}{%    set commit_descriptions = []
 %}{#
 #}{%    for commit in ns.commits
@@ -57,8 +57,8 @@ EXAMPLE:
             )
 %}{%      endif
 %}{%      set description = description | autofit_text_width(max_line_width, hanging_indent)
-%}{{      commit_descriptions.append(description) | default("", true)
-}}{%    endfor
+%}{%      set _ = commit_descriptions.append(description)
+%}{%    endfor
 %}{#
    #    # PRINT SECTION (header & commits)
 #}{%    if commit_descriptions | length > 0
@@ -81,18 +81,18 @@ EXAMPLE:
 #}{%  if breaking_commits | length > 0
 %}{#    PREPROCESS COMMITS
 #}{%    set brk_ns = namespace(commits=breaking_commits)
-%}{{    apply_alphabetical_ordering_by_brk_descriptions(brk_ns) | default("", true)
-}}{#
+%}{%    set _ = apply_alphabetical_ordering_by_brk_descriptions(brk_ns)
+%}{#
 #}{%    set brking_descriptions = []
 %}{#
 #}{%    for commit in brk_ns.commits
 %}{%      set full_description = "- %s" | format(
             format_breaking_changes_description(commit).split("\n\n") | join("\n\n- ")
           )
-%}{{      brking_descriptions.append(
+%}{%      set _ = brking_descriptions.append(
             full_description | autofit_text_width(max_line_width, hanging_indent)
-          ) | default("", true)
-}}{%    endfor
+          )
+%}{%    endfor
 %}{#
    #    # PRINT BREAKING CHANGE DESCRIPTIONS (header & descriptions)
 #}{{    "\n"
@@ -114,18 +114,18 @@ EXAMPLE:
 #}{%  if notice_commits | length > 0
 %}{#    PREPROCESS COMMITS
 #}{%    set notice_ns = namespace(commits=notice_commits)
-%}{{    apply_alphabetical_ordering_by_release_notices(notice_ns) | default("", true)
-}}{#
+%}{%    set _ = apply_alphabetical_ordering_by_release_notices(notice_ns)
+%}{#
 #}{%    set release_notices = []
 %}{#
 #}{%    for commit in notice_ns.commits
 %}{%      set full_description = "- %s" | format(
             format_release_notice(commit).split("\n\n") | join("\n\n- ")
           )
-%}{{      release_notices.append(
+%}{%      set _ = release_notices.append(
             full_description | autofit_text_width(max_line_width, hanging_indent)
-          ) | default("", true)
-}}{%    endfor
+          )
+%}{%    endfor
 %}{#
    #    # PRINT RELEASE NOTICE INFORMATION (header & descriptions)
 #}{{    "\n"

src/semantic_release/data/templates/angular/md/.components/first_release.md.j2

@@ -1,11 +1,18 @@
-{#
+{#  EXAMPLE:
 
 ## vX.X.X (YYYY-MMM-DD)
 
+_This release is published under the MIT License._       # Release Notes Only
+
+- Initial Release
+
 #}{{
-"## %s (%s)" | format(
+"## %s (%s)\n" | format(
     release.version.as_semver_tag(),
     release.tagged_date.strftime("%Y-%m-%d")
-)}}
-
+)
+}}{%  if license_name is defined and license_name
+%}{{    "\n_This release is published under the %s License._\n" | format(license_name)
+}}{%  endif
+%}
 - Initial Release

src/semantic_release/data/templates/angular/md/.components/versioned_changes.md.j2

@@ -1,14 +1,20 @@
-{#
+{#  EXAMPLE:
 
 ## vX.X.X (YYYY-MMM-DD)
 
-#}{{
+_This release is published under the MIT License._            # Release Notes Only
 
-      "## %s (%s)\n" | format(
-        release.version.as_semver_tag(),
-        release.tagged_date.strftime("%Y-%m-%d")
-      )
+{{ change_sections }}
 
-}}{%  set commit_objects = release["elements"] | dictsort
+#}{{
+"## %s (%s)\n" | format(
+  release.version.as_semver_tag(),
+  release.tagged_date.strftime("%Y-%m-%d")
+)
+}}{%  if license_name is defined and license_name
+%}{{    "\n_This release is published under the %s License._\n" | format(license_name)
+}}{%  endif
+%}{#
+#}{%  set commit_objects = release["elements"] | dictsort
 %}{%  include "changes.md.j2"
 -%}