python-semantic-release 9.13.0__tar.gz → 9.14.0__tar.gz

{python_semantic_release-9.13.0/src/python_semantic_release.egg-info → python_semantic_release-9.14.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-semantic-release
-Version: 9.13.0
+Version: 9.14.0
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT
@@ -58,7 +58,7 @@ Requires-Dist: pre-commit~=3.5; extra == "dev"
 Requires-Dist: tox~=4.11; extra == "dev"
 Requires-Dist: ruff==0.6.1; extra == "dev"
 Provides-Extra: mypy
-Requires-Dist: mypy==1.11.2; extra == "mypy"
+Requires-Dist: mypy==1.13.0; extra == "mypy"
 Requires-Dist: types-requests~=2.32.0; extra == "mypy"
 
 Python Semantic Release

{python_semantic_release-9.13.0 → python_semantic_release-9.14.0}/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.13.0
+    - uses: python-semantic-release/python-semantic-release@v9.14.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.13.0
+            uses: python-semantic-release/python-semantic-release@v9.14.0
             with:
               github_token: ${{ secrets.GITHUB_TOKEN }}
               git_committer_name: "github-actions"
@@ -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.13.0
+    uses: python-semantic-release/python-semantic-release@v9.14.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.13.0
+     uses: python-semantic-release/python-semantic-release@v9.14.0
      with:
        directory: ./project1
        github_token: ${{ secrets.GITHUB_TOKEN }}
 
    - name: Release Project 2
-     uses: python-semantic-release/python-semantic-release@v9.13.0
+     uses: python-semantic-release/python-semantic-release@v9.14.0
      with:
        directory: ./project2
        github_token: ${{ secrets.GITHUB_TOKEN }}

{python_semantic_release-9.13.0 → python_semantic_release-9.14.0}/docs/changelog_templates.rst

@@ -470,6 +470,26 @@ the ``context`` object has the following attributes:
       #}{%  endif
       %}
 
+* ``mask_initial_release (bool)``: a boolean value indicating whether the initial release
+  should be masked with a generic message. This value is passed directly from the
+  :ref:`changelog.default_templates.mask_initial_release <config-changelog-default_templates-mask_initial_release>`
+  configuration setting.
+
+  *Introduced in v9.14.0.*
+
+  **Example Usage:**
+
+  .. code:: jinja
+
+      #}{%  if releases | length == 1 and ctx.mask_initial_release
+      %}{#    # On a first release, generate a generic message
+      #}{%    include ".components/first_release.md.j2"
+      %}{%  else
+      %}{#    # Not the first release
+      #}{%    include ".components/versioned_changes.md.j2"
+      %}{%  endif
+      %}
+
 * ``repo_name (str)``: the name of the current repository parsed from the Git url.
 
   **Example Usage:**

{python_semantic_release-9.13.0 → python_semantic_release-9.14.0}/docs/configuration.rst

@@ -362,6 +362,36 @@ this setting is not used. See :ref:`config-changelog-template_dir` for more info
 
 ----
 
+.. _config-changelog-default_templates-mask_initial_release:
+
+``mask_initial_release``
+'''''''''''''''''''''''
+
+*Introduced in v9.14.0*
+
+**Type:** ``bool``
+
+This option toggles the behavior of the changelog and release note templates to mask
+the release details specifically for the first release. When set to ``true``, the
+first version release notes will be masked with a generic message as opposed to the
+usual commit details.  When set to ``false``, the release notes will be generated as
+normal.
+
+The reason for this setting is to improve clarity to your audience. It conceptually
+does **NOT** make sense to have a list of changes (i.e. a Changelog) for the first release
+since nothing has been published yet, therefore in the eyes of your consumers what change
+is there to document?
+
+The message details can be found in the ``first_release.md.j2`` and ``first_release.rst.j2``
+templates of the default changelog template directory.
+
+**Default:** ``false``
+
+.. seealso::
+   - :ref:`changelog-templates-default_changelog`
+
+----
+
 .. _config-changelog-default_templates-output_format:
 
 ``output_format``

{python_semantic_release-9.13.0 → python_semantic_release-9.14.0}/docs/index.rst

@@ -30,8 +30,8 @@ Read more about the setup and configuration in our `getting started guide`_.
 .. _GitHub Action: https://python-semantic-release.readthedocs.io/en/latest/automatic-releases/github-actions.html
 .. _conda-forge: https://anaconda.org/conda-forge/python-semantic-release
 
-.. |Test Status| image:: https://img.shields.io/github/actions/workflow/status/python-semantic-release/python-semantic-release/main.yml?branch=master&label=Test%20Status&logo=github
-   :target: https://github.com/python-semantic-release/python-semantic-release/actions/workflows/main.yml
+.. |Test Status| image:: https://img.shields.io/github/actions/workflow/status/python-semantic-release/python-semantic-release/cicd.yml?branch=master&label=Test%20Status&logo=github
+   :target: https://github.com/python-semantic-release/python-semantic-release/actions/workflows/cicd.yml
    :alt: test-status
 .. |PyPI Version| image:: https://img.shields.io/pypi/v/python-semantic-release?label=PyPI&logo=pypi
    :target: https://pypi.org/project/python-semantic-release/

{python_semantic_release-9.13.0 → python_semantic_release-9.14.0}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-semantic-release"
-version = "9.13.0"
+version = "9.14.0"
 description = "Automatic Semantic Versioning for Python projects"
 requires-python = ">=3.8"
 license = { text = "MIT" }
@@ -78,7 +78,7 @@ dev = [
   "ruff == 0.6.1"
 ]
 mypy = [
-  "mypy == 1.11.2",
+  "mypy == 1.13.0",
   "types-requests ~= 2.32.0",
 ]
 

{python_semantic_release-9.13.0 → python_semantic_release-9.14.0/src/python_semantic_release.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-semantic-release
-Version: 9.13.0
+Version: 9.14.0
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT
@@ -58,7 +58,7 @@ Requires-Dist: pre-commit~=3.5; extra == "dev"
 Requires-Dist: tox~=4.11; extra == "dev"
 Requires-Dist: ruff==0.6.1; extra == "dev"
 Provides-Extra: mypy
-Requires-Dist: mypy==1.11.2; extra == "mypy"
+Requires-Dist: mypy==1.13.0; extra == "mypy"
 Requires-Dist: types-requests~=2.32.0; extra == "mypy"
 
 Python Semantic Release

{python_semantic_release-9.13.0 → python_semantic_release-9.14.0}/src/python_semantic_release.egg-info/SOURCES.txt

@@ -68,6 +68,7 @@ src/semantic_release/data/templates/angular/md/.components/changelog_header.md.j
 src/semantic_release/data/templates/angular/md/.components/changelog_init.md.j2
 src/semantic_release/data/templates/angular/md/.components/changelog_update.md.j2
 src/semantic_release/data/templates/angular/md/.components/changes.md.j2
+src/semantic_release/data/templates/angular/md/.components/first_release.md.j2
 src/semantic_release/data/templates/angular/md/.components/macros.md.j2
 src/semantic_release/data/templates/angular/md/.components/unreleased_changes.md.j2
 src/semantic_release/data/templates/angular/md/.components/versioned_changes.md.j2
@@ -76,6 +77,7 @@ src/semantic_release/data/templates/angular/rst/.components/changelog_header.rst
 src/semantic_release/data/templates/angular/rst/.components/changelog_init.rst.j2
 src/semantic_release/data/templates/angular/rst/.components/changelog_update.rst.j2
 src/semantic_release/data/templates/angular/rst/.components/changes.rst.j2
+src/semantic_release/data/templates/angular/rst/.components/first_release.rst.j2
 src/semantic_release/data/templates/angular/rst/.components/macros.rst.j2
 src/semantic_release/data/templates/angular/rst/.components/unreleased_changes.rst.j2
 src/semantic_release/data/templates/angular/rst/.components/versioned_changes.rst.j2
@@ -139,6 +141,7 @@ tests/unit/conftest.py
 tests/unit/semantic_release/__init__.py
 tests/unit/semantic_release/test_helpers.py
 tests/unit/semantic_release/changelog/__init__.py
+tests/unit/semantic_release/changelog/conftest.py
 tests/unit/semantic_release/changelog/test_changelog_context.py
 tests/unit/semantic_release/changelog/test_default_changelog.py
 tests/unit/semantic_release/changelog/test_release_history.py

{python_semantic_release-9.13.0 → python_semantic_release-9.14.0}/src/python_semantic_release.egg-info/requires.txt

@@ -26,7 +26,7 @@ sphinx-autobuild==2024.2.4
 furo~=2024.1
 
 [mypy]
-mypy==1.11.2
+mypy==1.13.0
 types-requests~=2.32.0
 
 [test]

{python_semantic_release-9.13.0 → python_semantic_release-9.14.0}/src/semantic_release/__init__.py

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

{python_semantic_release-9.13.0 → python_semantic_release-9.14.0}/src/semantic_release/changelog/context.py

@@ -23,6 +23,7 @@ class ReleaseNotesContext:
     hvcs_type: str
     version: Version
     release: Release
+    mask_initial_release: bool
     filters: tuple[Callable[..., Any], ...] = ()
 
     def bind_to_environment(self, env: Environment) -> Environment:
@@ -53,6 +54,7 @@ class ChangelogContext:
     changelog_mode: Literal["update", "init"]
     prev_changelog_file: str
     changelog_insertion_flag: str
+    mask_initial_release: bool
     filters: tuple[Callable[..., Any], ...] = ()
 
     def bind_to_environment(self, env: Environment) -> Environment:
@@ -69,6 +71,7 @@ def make_changelog_context(
     mode: ChangelogMode,
     prev_changelog_file: Path,
     insertion_flag: str,
+    mask_initial_release: bool,
 ) -> ChangelogContext:
     return ChangelogContext(
         repo_name=hvcs_client.repo_name,
@@ -76,6 +79,7 @@ def make_changelog_context(
         history=release_history,
         changelog_mode=mode.value,
         changelog_insertion_flag=insertion_flag,
+        mask_initial_release=mask_initial_release,
         prev_changelog_file=str(prev_changelog_file),
         hvcs_type=hvcs_client.__class__.__name__.lower(),
         filters=(
@@ -111,6 +115,11 @@ def convert_md_to_rst(md_content: str) -> str:
         "bullets": (regexp(r"^(\s*)-(\s)"), r"\1*\2"),
         # Replace markdown inline raw content with rst inline raw content
         "raw-inline": (regexp(r"(?<=\s)(`[^`]+`)(?![`_])"), r"`\1`"),
+        # Replace markdown inline link with rst inline link
+        "link-inline": (
+            regexp(r"(?<=\s)\[([^\]]+)\]\(([^)]+)\)(?=\s|$)"),
+            r"`\1 <\2>`_",
+        ),
     }
 
     for pattern, replacement in replacements.values():

{python_semantic_release-9.13.0 → python_semantic_release-9.14.0}/src/semantic_release/cli/changelog_writer.py

@@ -178,6 +178,7 @@ def write_changelog_files(
         mode=runtime_ctx.changelog_mode,
         insertion_flag=runtime_ctx.changelog_insertion_flag,
         prev_changelog_file=runtime_ctx.changelog_file,
+        mask_initial_release=runtime_ctx.changelog_mask_initial_release,
     )
 
     user_templates = []
@@ -226,6 +227,7 @@ def generate_release_notes(
     template_dir: Path,
     history: ReleaseHistory,
     style: str,
+    mask_initial_release: bool,
 ) -> str:
     users_tpl_file = template_dir / DEFAULT_RELEASE_NOTES_TPL_FILE
 
@@ -251,6 +253,7 @@ def generate_release_notes(
         hvcs_type=hvcs_client.__class__.__name__.lower(),
         version=release["version"],
         release=release,
+        mask_initial_release=mask_initial_release,
         filters=(*hvcs_client.get_changelog_context_filters(), autofit_text_width),
     ).bind_to_environment(
         # Use a new, non-configurable environment for release notes -
@@ -259,11 +262,9 @@ def generate_release_notes(
     )
 
     # TODO: Remove in v10
-    release_notes_env.globals["context"] = {
-        "history": history,
-    }
-    release_notes_env.globals["ctx"] = {
+    release_notes_env.globals["context"] = release_notes_env.globals["ctx"] = {
         "history": history,
+        "mask_initial_release": mask_initial_release,
     }
 
     return render_release_notes(

{python_semantic_release-9.13.0 → python_semantic_release-9.14.0}/src/semantic_release/cli/commands/changelog.py

@@ -119,6 +119,7 @@ def changelog(cli_ctx: CliContextObj, release_tag: str | None) -> None:
         runtime.template_dir,
         release_history,
         style=runtime.changelog_style,
+        mask_initial_release=runtime.changelog_mask_initial_release,
     )
 
     try:

{python_semantic_release-9.13.0 → python_semantic_release-9.14.0}/src/semantic_release/cli/commands/version.py

@@ -696,6 +696,7 @@ def version(  # noqa: C901
         runtime.template_dir,
         history=release_history,
         style=runtime.changelog_style,
+        mask_initial_release=runtime.changelog_mask_initial_release,
     )
 
     exception: Exception | None = None

{python_semantic_release-9.13.0 → python_semantic_release-9.14.0}/src/semantic_release/cli/config.py

@@ -123,6 +123,8 @@ class ChangelogEnvironmentConfig(BaseModel):
 class DefaultChangelogTemplatesConfig(BaseModel):
     changelog_file: str = "CHANGELOG.md"
     output_format: ChangelogOutputFormat = ChangelogOutputFormat.NONE
+    # TODO: Breaking Change v10, it will become True
+    mask_initial_release: bool = False
 
     @model_validator(mode="after")
     def interpret_output_format(self) -> Self:
@@ -511,6 +513,7 @@ class RuntimeContext:
     version_declarations: Tuple[VersionDeclarationABC, ...]
     hvcs_client: hvcs.HvcsBase
     changelog_insertion_flag: str
+    changelog_mask_initial_release: bool
     changelog_mode: ChangelogMode
     changelog_file: Path
     changelog_style: str
@@ -795,6 +798,7 @@ class RuntimeContext:
             hvcs_client=hvcs_client,
             changelog_file=changelog_file,
             changelog_mode=raw.changelog.mode,
+            changelog_mask_initial_release=raw.changelog.default_templates.mask_initial_release,
             changelog_insertion_flag=raw.changelog.insertion_flag,
             assets=raw.assets,
             commit_author=commit_author,

python_semantic_release-9.14.0/src/semantic_release/data/templates/angular/md/.components/changelog_init.md.j2

@@ -0,0 +1,29 @@
+{#
+This changelog template initializes a full changelog for the project,
+it follows the following logic:
+  1. Header
+  2. Any Unreleased Details (uncommon)
+  3. all previous releases except the very first release
+  4. the first release
+
+#}{#
+   #    Header
+#}{%    include "changelog_header.md.j2"
+-%}{#
+   #    Any Unreleased Details (uncommon)
+#}{%    include "unreleased_changes.md.j2"
+-%}{#
+    #   Since this is initialization, we are generating all the previous
+    #   release notes per version. The very first release notes is specialized
+#}{%    if releases | length > 0
+%}{%      for release in releases
+%}{{        "\n"
+}}{%        if loop.last and ctx.mask_initial_release
+%}{%-         include "first_release.md.j2"
+-%}{%       else
+%}{%-         include "versioned_changes.md.j2"
+-%}{%       endif
+%}{{       "\n"
+}}{%      endfor
+%}{%    endif
+%}

{python_semantic_release-9.13.0 → python_semantic_release-9.14.0}/src/semantic_release/data/templates/angular/md/.components/changelog_update.md.j2

@@ -41,15 +41,24 @@ This Update changelog template uses the following logic:
    #    Any Unreleased Details (uncommon)
 #}{%    include "unreleased_changes.md.j2"
 -%}{#
-   #    Latest Release Details
-#}{%    for release in new_releases
-%}{#      # Check if the release version is already in the changelog and if not, add it
-#}{%      if "# " ~ release.version.as_semver_tag() ~ " " not in changelog_parts[1]
-%}{{        "\n"
+#}{%    if releases | length > 0
+%}{#      # Latest Release Details
+#}{%      set release = releases[0]
+%}{#
+#}{%      if releases | length == 1 and ctx.mask_initial_release
+%}{#        # First Release detected
+#}{{        "\n"
+}}{%-       include "first_release.md.j2"
+-%}{{       "\n"
+}}{#
+#}{%      elif "# " ~ release.version.as_semver_tag() ~ " " not in changelog_parts[1]
+%}{#        # The release version is not already in the changelog so we add it
+#}{{        "\n"
 }}{%-       include "versioned_changes.md.j2"
 -%}{{       "\n"
-}}{%      endif
-%}{%    endfor
+}}{#
+#}{%      endif
+%}{%    endif
 %}{#
    #    Previous Changelog Footer
    #      - skips printing footer if empty, which happens when the insertion_flag

{python_semantic_release-9.13.0 → python_semantic_release-9.14.0}/src/semantic_release/data/templates/angular/md/.components/changes.md.j2

@@ -7,15 +7,15 @@ EXAMPLE:
 - Add new feature ([#10](https://domain.com/namespace/repo/pull/10),
   [`abcdef0`](https://domain.com/namespace/repo/commit/HASH))
 
-- Add new feature ([`abcdef0`](https://domain.com/namespace/repo/commit/HASH))
+- **scope**: Add new feature ([`abcdef0`](https://domain.com/namespace/repo/commit/HASH))
 
 ### Fixes
 
 - Fix bug ([#11](https://domain.com/namespace/repo/pull/11),
   [`abcdef1`](https://domain.com/namespace/repo/commit/HASH))
 
-#}{%  set max_line_width = 100
-%}{%  set hanging_indent = 2
+#}{%  set max_line_width = max_line_width | default(100)
+%}{%  set hanging_indent = hanging_indent | default(2)
 %}{#
 #}{%  for type_, commits in commit_objects if type_ != "unknown"
 %}{#    PREPROCESS COMMITS (order by description & format description line)

python_semantic_release-9.14.0/src/semantic_release/data/templates/angular/md/.components/first_release.md.j2

@@ -0,0 +1,11 @@
+{#
+
+## vX.X.X (YYYY-MMM-DD)
+
+#}{{
+"## %s (%s)" | format(
+    release.version.as_semver_tag(),
+    release.tagged_date.strftime("%Y-%m-%d")
+)}}
+
+- Initial Release

{python_semantic_release-9.13.0 → python_semantic_release-9.14.0}/src/semantic_release/data/templates/angular/md/.components/macros.md.j2

@@ -1,9 +1,18 @@
+{#
+  MACRO: format a inline link reference in Markdown
+#}{%  macro format_link(link, label)
+%}{{    "[%s](%s)" | format(label, link)
+}}{%  endmacro
+%}
+
+
 {#
   MACRO: commit message links or PR/MR links of commit
 #}{%  macro commit_msg_links(commit)
 %}{%    if commit.error is undefined
-%}{%      set commit_hash_link = "[`%s`](%s)" | format(
-            commit.short_hash, commit.hexsha | commit_hash_url
+%}{%      set commit_hash_link = format_link(
+            commit.hexsha | commit_hash_url,
+            "`%s`" | format(commit.short_hash)
           )
 %}{#
 #}{%      set summary_line = commit.descriptions[0] | safe
@@ -15,7 +24,7 @@
 #}{%      if commit.linked_merge_request != ""
 %}{#        # Add PR references with a link to the PR
 #}{%        set pr_num = commit.linked_merge_request
-%}{%        set pr_link = "[%s](%s)" | format(pr_num, pr_num | pull_request_url)
+%}{%        set pr_link = format_link(pr_num | pull_request_url, pr_num)
 %}{#
    #        TODO: breaking change v10, remove summary line replacers as PSR will do it for us
 #}{%        set summary_line = summary_line | replace("(pull request", "(") | replace("(" ~ pr_num ~ ")", "") | trim
@@ -39,10 +48,22 @@
 {#
   MACRO: format commit summary line
 #}{%  macro format_commit_summary_line(commit)
-%}{%    if commit.error is undefined
-%}{{      commit_msg_links(commit)
-}}{%    else
-%}{{      (commit.commit.message | string).split("\n", maxsplit=1)[0]
+%}{#    # Check for Parsing Error
+#}{%    if commit.error is undefined
+%}{#
+   #      # Add any message links to the commit summary line
+#}{%      set summary_line = commit_msg_links(commit)
+%}{#
+#}{%      if commit.scope
+%}{%        set summary_line = "**%s**: %s" | format(commit.scope, summary_line)
+%}{%      endif
+%}{#
+   #      # Return the modified summary_line
+#}{{      summary_line
+}}{#
+#}{%    else
+%}{#      # Return the first line of the commit if there was a Parsing Error
+#}{{      (commit.commit.message | string).split("\n", maxsplit=1)[0]
 }}{%    endif
 %}{%  endmacro
 %}

python_semantic_release-9.14.0/src/semantic_release/data/templates/angular/md/.release_notes.md.j2

@@ -0,0 +1,13 @@
+{#    # 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 releases = context.history.released.items() | list
+%}{#
+#}{%  if releases | length == 1 and mask_initial_release
+%}{#    # On a first release, generate our special message
+#}{%    include ".components/first_release.md.j2"
+%}{%  else
+%}{#    # Not the first release so generate notes normally
+#}{%    include ".components/versioned_changes.md.j2"
+%}{%  endif
+%}

{python_semantic_release-9.13.0 → python_semantic_release-9.14.0}/src/semantic_release/data/templates/angular/md/CHANGELOG.md.j2

@@ -15,10 +15,6 @@
 %}{#
 #}{%  elif ctx.changelog_mode == "update"
 %}{%    set prev_changelog_file = ctx.prev_changelog_file
-%}{%    set new_releases = []
-%}{%    if releases | length > 0
-%}{%      set new_releases = [releases | first]
-%}{%    endif
 %}{%    include ".components/changelog_update.md.j2"
 %}{#
 #}{%  endif

python_semantic_release-9.14.0/src/semantic_release/data/templates/angular/rst/.components/changelog_init.rst.j2

@@ -0,0 +1,29 @@
+{#
+This changelog template initializes a full changelog for the project,
+it follows the following logic:
+  1. Header
+  2. Any Unreleased Details (uncommon)
+  3. all previous releases except the very first release
+  4. the first release
+
+#}{#
+   #    Header
+#}{%    include "changelog_header.rst.j2"
+-%}{#
+   #    Any Unreleased Details (uncommon)
+#}{%    include "unreleased_changes.rst.j2"
+-%}{#
+    #   Since this is initialization, we are generating all the previous
+    #   release notes per version. The very first release notes is specialized
+#}{%    if releases | length > 0
+%}{%      for release in releases
+%}{{        "\n"
+}}{%        if loop.last and ctx.mask_initial_release
+%}{%-         include "first_release.rst.j2"
+-%}{%       else
+%}{%-         include "versioned_changes.rst.j2"
+-%}{%       endif
+%}{{       "\n"
+}}{%      endfor
+%}{%    endif
+%}

{python_semantic_release-9.13.0 → python_semantic_release-9.14.0}/src/semantic_release/data/templates/angular/rst/.components/changelog_update.rst.j2

@@ -41,15 +41,24 @@ This Update changelog template uses the following logic:
    #    Any Unreleased Details (uncommon)
 #}{%    include "unreleased_changes.rst.j2"
 -%}{#
-   #    Latest Release Details
-#}{%    for release in new_releases
-%}{#      # Check if the release version is already in the changelog and if not, add it
-#}{%      if release.version.as_semver_tag() ~ " (" not in changelog_parts[1]
-%}{{        "\n"
+#}{%    if releases | length > 0
+%}{#      # Latest Release Details
+#}{%      set release = releases[0]
+%}{#
+#}{%      if releases | length == 1 and ctx.mask_initial_release
+%}{#        # First Release detected
+#}{{        "\n"
+}}{%-       include "first_release.rst.j2"
+-%}{{       "\n"
+}}{#
+#}{%      elif release.version.as_semver_tag() ~ " (" not in changelog_parts[1]
+%}{#        # The release version is not already in the changelog so we add it
+#}{{        "\n"
 }}{%-       include "versioned_changes.rst.j2"
 -%}{{       "\n"
-}}{%      endif
-%}{%    endfor
+}}{#
+#}{%      endif
+%}{%    endif
 %}{#
    #    Previous Changelog Footer
    #      - skips printing footer if empty, which happens when the insertion_flag

{python_semantic_release-9.13.0 → python_semantic_release-9.14.0}/src/semantic_release/data/templates/angular/rst/.components/changes.rst.j2

@@ -7,7 +7,7 @@ Features
 
 * Add new feature (`#10`_, `8a7b8ec`_)
 
-* Add another feature (`abcdef0`_)
+* **scope**: Add another feature (`abcdef0`_)
 
 Fixes
 -----
@@ -19,8 +19,8 @@ Fixes
 .. _abcdef0: https://domain.com/owner/repo/commit/abcdef0
 .. _11: https://domain.com/namespace/repo/pull/11
 
-#}{%  set max_line_width = 100
-%}{%  set hanging_indent = 2
+#}{%  set max_line_width = max_line_width | default(100)
+%}{%  set hanging_indent = hanging_indent | default(2)
 %}{#
 #}{%  set post_paragraph_links = []
 %}{#

python_semantic_release-9.14.0/src/semantic_release/data/templates/angular/rst/.components/first_release.rst.j2

@@ -0,0 +1,20 @@
+{% from "macros.rst.j2" import generate_heading_underline
+%}{#
+
+.. _changelog-vX.X.X:
+
+vX.X.X (YYYY-MMM-DD)
+====================
+
+#}{%  set version_header = "%s (%s)" | format(
+        release.version.as_semver_tag(),
+        release.tagged_date.strftime("%Y-%m-%d")
+      )
+%}
+
+{{- ".. _changelog-%s:" | format(release.version.as_semver_tag()) }}
+
+{{ version_header }}
+{{ generate_heading_underline(version_header, "=") }}
+
+* Initial Release

{python_semantic_release-9.13.0 → python_semantic_release-9.14.0}/src/semantic_release/data/templates/angular/rst/.components/macros.rst.j2

@@ -9,10 +9,22 @@
 {#
   MACRO: format commit summary line
 #}{%  macro format_commit_summary_line(commit)
-%}{%    if commit.error is undefined
-%}{{      commit_msg_links(commit)
-}}{%    else
-%}{{      (commit.commit.message | string).split("\n", maxsplit=1)[0]
+%}{#    # Check for Parsing Error
+#}{%    if commit.error is undefined
+%}{#
+   #      # Add any message links to the commit summary line
+#}{%      set summary_line = commit_msg_links(commit)
+%}{#
+#}{%      if commit.scope
+%}{%        set summary_line = "**%s**: %s" | format(commit.scope, summary_line)
+%}{%      endif
+%}{#
+   #      # Return the modified summary_line
+#}{{      summary_line
+}}{#
+#}{%    else
+%}{#      # Return the first line of the commit if there was a Parsing Error
+#}{{      (commit.commit.message | string).split("\n", maxsplit=1)[0]
 }}{%    endif
 %}{%  endmacro
 %}