python-semantic-release 9.13.0__py3-none-any.whl → 9.14.0__py3-none-any.whl

{python_semantic_release-9.13.0.dist-info → python_semantic_release-9.14.0.dist-info}/METADATA

@@ -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
@@ -44,7 +44,7 @@ Requires-Dist: sphinxcontrib-apidoc==0.5.0; extra == "docs"
 Requires-Dist: sphinx-autobuild==2024.2.4; extra == "docs"
 Requires-Dist: furo~=2024.1; extra == "docs"
 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"
 Provides-Extra: test
 Requires-Dist: coverage[toml]~=7.0; extra == "test"

{python_semantic_release-9.13.0.dist-info → python_semantic_release-9.14.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-semantic_release/__init__.py,sha256=HkSV-d4oTywSXoJB6atMrEkQnimWPdJJGqSSrFeYjQQ,1229
+semantic_release/__init__.py,sha256=kHQQzNnUYSMycf0e29x0t_WKKyKzPNRw9RkN73SVOpw,1229
 semantic_release/__main__.py,sha256=kuotDU7aFKrCBeAJUPWrbIxgJWAmrXUMnztCqWMDMPY,1292
 semantic_release/const.py,sha256=Z1o2QNh60wSLeF-_1TemMBjU3ZXbV0XghnUFsbTVfOs,831
 semantic_release/enums.py,sha256=D5B_reQGGKQQT22HO5PUtvn2Bok3fkht6TfJtXkmAUg,1020
@@ -7,23 +7,23 @@ semantic_release/gitproject.py,sha256=izWc4NLdUzAwxGG_fJeqqHW9ivSrPcWBzSaOijQx4f
 semantic_release/globals.py,sha256=imI9WKGa6MS2pTRAZiWZ2qIJup2eWnBz3OZmIj2YIHM,158
 semantic_release/helpers.py,sha256=d1jOX0SNyqPc_3wr14xR25FfpqhMd4Ev7MNBOWlScc0,5581
 semantic_release/changelog/__init__.py,sha256=Bg6Xe5Vt32rWoMscW-hd4sUwiZqzWmsg4CD1EhMesMY,262
-semantic_release/changelog/context.py,sha256=y37y3M7UmVKwhu9UatNtlo5zNfTOJI8gGOTIzjYXVa8,5023
+semantic_release/changelog/context.py,sha256=AQY9ZH1c5LjkyMcZyZG8Kjeyg0qvG_ueOWifgshtLWY,5354
 semantic_release/changelog/release_history.py,sha256=8RU6A4FMgWwwjndOO4WKjbSzPWgVsYbdcZol1xUPnfo,7815
 semantic_release/changelog/template.py,sha256=J1YJDI_SnXtBbTxoahN0NaVVHN7grOFghLwE9wDjxik,5685
 semantic_release/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-semantic_release/cli/changelog_writer.py,sha256=qucHQylViw61C8Rn3Lafbeyo80cjs2hxaCztd_EgIJ4,8859
+semantic_release/cli/changelog_writer.py,sha256=4XWAiH2qv3WBLxPm0D0S31-0XDm2QwSwyopiUmjUdJk,9029
 semantic_release/cli/cli_context.py,sha256=23eyV6KWIpUckUSWILEd7t9dixp-QCY5-kGZnyucEYY,4114
-semantic_release/cli/config.py,sha256=0btSbu5KKFZ3HFqR_-WDyToWXljfv1EOuBjBqwwFJcc,30654
+semantic_release/cli/config.py,sha256=XpFT5asSe65ye3Q63h9HaDJ4lTzWKyUBXyn_tZSdamk,30884
 semantic_release/cli/const.py,sha256=h7XE2D0D__TAZSrUUtVszwvzpkHTMOiQCf97XQNbEvA,163
 semantic_release/cli/github_actions_output.py,sha256=VYIOb5x5h8eEJdSlXM_mkhT9xXtYi-RgxvnoM7iUn8s,2288
 semantic_release/cli/masking_filter.py,sha256=DxqjiJyABlzwwwZ1r8JGQpb6QrF00StJFm0-2-s5Fv0,3071
 semantic_release/cli/util.py,sha256=FyXaBkeL7nXKjy3X9rQLEwvn7p46xPekp2V8Z-5MVrk,3755
 semantic_release/cli/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-semantic_release/cli/commands/changelog.py,sha256=kVHcGdfud74-M6hjWf1PS6l95gD4yUlu3CZGBkCt7aY,3765
+semantic_release/cli/commands/changelog.py,sha256=6SLdz8zHuLDXnB8JWz8NSko9c5YNLMmRoBw_9DrkRok,3834
 semantic_release/cli/commands/generate_config.py,sha256=2xZOu3NpyhBp0pWr7d8ugKl_kjqQgpSsSMHq5wHTfrE,1699
 semantic_release/cli/commands/main.py,sha256=wHG51tbaAHKra21nRe3-FAfQT81-e5PGhv0KnerS15c,4100
 semantic_release/cli/commands/publish.py,sha256=SZQlIewvqyIC14dkIIVVFetE0tPsKbO1cUyxnZsicrw,2845
-semantic_release/cli/commands/version.py,sha256=PKNoP_b8puzcScKkQEbeB3DviJv49cQ-vjq6v25nG9Q,23931
+semantic_release/cli/commands/version.py,sha256=z4UNNmQ0Fo2e-SKPzmF1CF517X5mk8oaiGttYJAiVzA,24000
 semantic_release/commit_parser/__init__.py,sha256=cv5HFBdw7OJd4Laj4Ex8ZZ5Tml8GwXgQcXW6Pasr2Ao,615
 semantic_release/commit_parser/_base.py,sha256=t-Z9ALgAe7aZpYXz1mk3Fe-uAvipgKdNrq4Okg_WW9c,3026
 semantic_release/commit_parser/angular.py,sha256=a1AmgstkclzJnRWqSsF4cuO8awuOJe7VAG__1W7WF7U,7276
@@ -32,21 +32,23 @@ semantic_release/commit_parser/scipy.py,sha256=u_5OWOeM2V7_jZzYfEicKqx0GJBsAqIOf
 semantic_release/commit_parser/tag.py,sha256=4uwIKBqUM2SE6UTGIw-a7B6Jg1OONXmGwXsTyL3yZBA,3490
 semantic_release/commit_parser/token.py,sha256=-C1ZKG7pdbcGT2nc3-L2APLUUDGTXkbDeNi5mvvUwjk,2621
 semantic_release/commit_parser/util.py,sha256=b9lud_FBjsmimLrvILf_NXvZ2wg8JPDmA364hcfM6is,1710
-semantic_release/data/templates/angular/md/.release_notes.md.j2,sha256=bJeaCDzbva8ntefPPeAS3YD0GXkZv-j0_fIbVmnAKbQ,52
-semantic_release/data/templates/angular/md/CHANGELOG.md.j2,sha256=zsf5C75jBP2JUdl_7dJvEXgPURvFp6GxPKGRelqLghM,854
+semantic_release/data/templates/angular/md/.release_notes.md.j2,sha256=1wGyJGiML0FeSsHeywj4gv5qhAZHvs0wvea7eCIGiwM,558
+semantic_release/data/templates/angular/md/CHANGELOG.md.j2,sha256=FZmrQ-qOIoSoJmAa_NFaRelfmqUpypU2xlDeScdGOf4,729
 semantic_release/data/templates/angular/md/.components/changelog_header.md.j2,sha256=qNxTuSr59CV_yyimVU_RYp5azCnK0l6nJ03Zf0u5Ugg,166
-semantic_release/data/templates/angular/md/.components/changelog_init.md.j2,sha256=d3tS_nCe_ttNQRGl8Jan4H42iJ8hKu03HrfdEdGAh5M,599
-semantic_release/data/templates/angular/md/.components/changelog_update.md.j2,sha256=JhXF-vYlqd4qNI8rO2Hte3Jbemo17wdeZ7w3G2nwjus,2384
-semantic_release/data/templates/angular/md/.components/changes.md.j2,sha256=qA190vxbADim4M1b2f-oWF4uWT7Vx8ToSjKrRkPeJfA,1638
-semantic_release/data/templates/angular/md/.components/macros.md.j2,sha256=cUrl4tqjhR6Ur-gl_gHsuRz1DVU7X_-0QYnswahoTm0,1709
+semantic_release/data/templates/angular/md/.components/changelog_init.md.j2,sha256=MyEQdWUemGXKWDhvpTmubZdozd3iaLECZAI1VRlE7mg,862
+semantic_release/data/templates/angular/md/.components/changelog_update.md.j2,sha256=uVF4wbbjTMvl6Kbsq9xy3YIrj-uhBnHylEfA7S76aHI,2606
+semantic_release/data/templates/angular/md/.components/changes.md.j2,sha256=PAt_vMMoP5uMbDQZKemx26m13TNGGAOmBVD1sUU-KNo,1701
+semantic_release/data/templates/angular/md/.components/first_release.md.j2,sha256=jMUZiLwhMqAOjdYOCphJxJr8C411cKRzhsabyebj_AY,162
+semantic_release/data/templates/angular/md/.components/macros.md.j2,sha256=rvMLeThRRmCVyF_utN0j6wrWL5PVb4TYraunOWWcdu4,2275
 semantic_release/data/templates/angular/md/.components/unreleased_changes.md.j2,sha256=HRLj6cyRfPZXC0s-0Av6s0Gp3jKxWg9AIEtIXBVqJuY,177
 semantic_release/data/templates/angular/md/.components/versioned_changes.md.j2,sha256=2Hky2mBrC4jltz3mvaiPDD0KQP0ELe5Ag75HgaLpaIE,257
-semantic_release/data/templates/angular/rst/CHANGELOG.rst.j2,sha256=OQPAKgqTnYGXFyDTm8hwYsMWXfi_z8I5Fsgtw09sWBQ,840
+semantic_release/data/templates/angular/rst/CHANGELOG.rst.j2,sha256=VmkXEMHiPBdZ1Z47QMxnJBZA0NbFSbKenUbThQVFAGY,731
 semantic_release/data/templates/angular/rst/.components/changelog_header.rst.j2,sha256=c9xN1SEYLFwMvPYXYKt-ZbYPn2-Ss0V7zepEtFFj3Os,200
-semantic_release/data/templates/angular/rst/.components/changelog_init.rst.j2,sha256=dOICVsTMVLewBDC9QMHhX6Ub9rUFlBAzHOGvsFtNzYY,596
-semantic_release/data/templates/angular/rst/.components/changelog_update.rst.j2,sha256=L44PJyCb1xge2wC2-w9cAPCLoJDFVIsm8BnZeQOzg94,2381
-semantic_release/data/templates/angular/rst/.components/changes.rst.j2,sha256=0JDnsFghFqHezOim9IuQhlVig5mHBKf8Aq7_Y9M2UQE,2852
-semantic_release/data/templates/angular/rst/.components/macros.rst.j2,sha256=C_5V80wQu-uCLE_Qp3ACwGS-4jQDGc7NmKaDi3C6m1s,2774
+semantic_release/data/templates/angular/rst/.components/changelog_init.rst.j2,sha256=XD0l3eTyz1yydLKsmSqBk-u8RnO-RdQ2Q8uWezHMAWw,866
+semantic_release/data/templates/angular/rst/.components/changelog_update.rst.j2,sha256=x23-qk9owJrOQaHx8SgSnIZECITjPf1R2awfv9EOHN0,2604
+semantic_release/data/templates/angular/rst/.components/changes.rst.j2,sha256=REgnXdUDQKH2_BakQ-zbQtS4-MJMYKtA1jBXYFhfSjk,2915
+semantic_release/data/templates/angular/rst/.components/first_release.rst.j2,sha256=tChYsdSFMaB0DU9KROYSxijdb7tqaN1psKmDMbrVrJw,443
+semantic_release/data/templates/angular/rst/.components/macros.rst.j2,sha256=C4JkbfM9mfal-fMJJp6dPUT45PsqwfsCFu4pfZe34QI,3176
 semantic_release/data/templates/angular/rst/.components/unreleased_changes.rst.j2,sha256=ARBhc1ZpKwehGKDvOMqukmN59mTJiHzHsS7rOfKYCt8,202
 semantic_release/data/templates/angular/rst/.components/versioned_changes.rst.j2,sha256=NZfn1W14QochiAJ43oNKmcrCn_vgfbkKtvOTAw1jEc8,530
 semantic_release/hvcs/__init__.py,sha256=JwoaLOF-12L-OBo_9-tOXXhdiHKeVungA9865to2oZk,494
@@ -63,10 +65,10 @@ semantic_release/version/algorithm.py,sha256=ofx_bIWq6ptJVr-ekI11IzxzDEctDKFiVwa
 semantic_release/version/declaration.py,sha256=f6Ld7hIhrqvDrRBapJHr-KDimuyo-4IG8009Zu9BIgU,7357
 semantic_release/version/translator.py,sha256=P1noIsVBn8u6zNOFjG0xKYOWapxqf_PHSMvMeLJ9kXg,3050
 semantic_release/version/version.py,sha256=6PCtSbLP88U1daoxnCwHc--YguZo4waGNLqJ5JfeczE,14175
-python_semantic_release-9.13.0.dist-info/AUTHORS.rst,sha256=XOReVvpymEFUPsS2QPH97jlfJBVrxwS2eu8-jVAe4gk,230
-python_semantic_release-9.13.0.dist-info/LICENSE,sha256=NE85nszX252sdQdu0xgS9qwfYES0k8qS6gW3uO4jRGE,1083
-python_semantic_release-9.13.0.dist-info/METADATA,sha256=aFjXFtGi0j7sN3G2CfwdCPBGENzFlgkU9a2oDp_2Jeo,3571
-python_semantic_release-9.13.0.dist-info/WHEEL,sha256=bFJAMchF8aTQGUgMZzHJyDDMPTO3ToJ7x23SLJa1SVo,92
-python_semantic_release-9.13.0.dist-info/entry_points.txt,sha256=r2Jql3GTQyugQnvf34l2eXk1O_Qx6llR_xixG1ZWgD0,105
-python_semantic_release-9.13.0.dist-info/top_level.txt,sha256=qYA24nyg3eP-ti5UW7Vuj2aXVmM0wqVHx4mREdRZNAA,17
-python_semantic_release-9.13.0.dist-info/RECORD,,
+python_semantic_release-9.14.0.dist-info/AUTHORS.rst,sha256=XOReVvpymEFUPsS2QPH97jlfJBVrxwS2eu8-jVAe4gk,230
+python_semantic_release-9.14.0.dist-info/LICENSE,sha256=NE85nszX252sdQdu0xgS9qwfYES0k8qS6gW3uO4jRGE,1083
+python_semantic_release-9.14.0.dist-info/METADATA,sha256=tY6DDyFypAxFHo8kVuuCecr3h_siBZ7RO88JOQAIZQ4,3571
+python_semantic_release-9.14.0.dist-info/WHEEL,sha256=bFJAMchF8aTQGUgMZzHJyDDMPTO3ToJ7x23SLJa1SVo,92
+python_semantic_release-9.14.0.dist-info/entry_points.txt,sha256=r2Jql3GTQyugQnvf34l2eXk1O_Qx6llR_xixG1ZWgD0,105
+python_semantic_release-9.14.0.dist-info/top_level.txt,sha256=qYA24nyg3eP-ti5UW7Vuj2aXVmM0wqVHx4mREdRZNAA,17
+python_semantic_release-9.14.0.dist-info/RECORD,,

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",

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():

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(

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:

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

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,

semantic_release/data/templates/angular/md/.components/changelog_init.md.j2

@@ -3,7 +3,8 @@ 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
+  3. all previous releases except the very first release
+  4. the first release
 
 #}{#
    #    Header
@@ -13,10 +14,16 @@ it follows the following logic:
 #}{%    include "unreleased_changes.md.j2"
 -%}{#
     #   Since this is initialization, we are generating all the previous
-    #   release notes per version.
-#}{%    for release in context.history.released.values()
-%}{{      "\n"
-}}{%      include "versioned_changes.md.j2"
--%}{{     "\n"
-}}{%    endfor
+    #   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
 %}

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

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)

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

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
 %}

semantic_release/data/templates/angular/md/.release_notes.md.j2

@@ -1 +1,13 @@
-{% include ".components/versioned_changes.md.j2" %}
+{#    # 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
+%}

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

semantic_release/data/templates/angular/rst/.components/changelog_init.rst.j2

@@ -3,20 +3,27 @@ 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
+  3. all previous releases except the very first release
+  4. the first release
 
 #}{#
-   #   Header
-#}{%   include "changelog_header.rst.j2"
+   #    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.
-#}{%   for release in context.history.released.values()
+   #    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"
-}}{%       include "versioned_changes.rst.j2"
--%}{{      "\n"
-}}{%   endfor
+}}{%      endfor
+%}{%    endif
 %}

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

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 = []
 %}{#

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

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
 %}

semantic_release/data/templates/angular/rst/CHANGELOG.rst.j2

@@ -8,16 +8,13 @@
 
 #}{%  set insertion_flag = ctx.changelog_insertion_flag
 %}{%  set unreleased_commits = ctx.history.unreleased | dictsort
+%}{%  set releases = ctx.history.released.values() | list
 %}{#
 #}{%  if ctx.changelog_mode == "init"
 %}{%    include ".components/changelog_init.rst.j2"
 %}{#
 #}{%  elif ctx.changelog_mode == "update"
 %}{%    set prev_changelog_file = ctx.prev_changelog_file
-%}{%    set new_releases = []
-%}{%    if ctx.history.released.values() | length > 0
-%}{%      set new_releases = [ctx.history.released.values() | first]
-%}{%    endif
 %}{%    include ".components/changelog_update.rst.j2"
 %}{#
 #}{%  endif