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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-semantic-release
-Version: 9.13.0
+Version: 9.15.0
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT
@@ -16,6 +16,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.8
 Description-Content-Type: text/x-rst
 License-File: LICENSE
@@ -41,6 +42,9 @@ Requires-Dist: sphinx-autobuild==2024.2.4; extra == "docs"
 Requires-Dist: furo~=2024.1; extra == "docs"
 Provides-Extra: test
 Requires-Dist: coverage[toml]~=7.0; extra == "test"
+Requires-Dist: filelock~=3.15; extra == "test"
+Requires-Dist: flatdict~=4.0; extra == "test"
+Requires-Dist: freezegun~=1.5; extra == "test"
 Requires-Dist: pyyaml~=6.0; extra == "test"
 Requires-Dist: pytest~=8.3; extra == "test"
 Requires-Dist: pytest-clarity~=1.0; extra == "test"
@@ -58,8 +62,9 @@ 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"
+Requires-Dist: types-pyyaml~=6.0; extra == "mypy"
 
 Python Semantic Release
 ***********************

{python_semantic_release-9.13.0 → python_semantic_release-9.15.0}/docs/automatic-releases/github-actions.rst

@@ -71,7 +71,7 @@ outlines each supported input and its purpose.
 .. _gh_actions-psr-inputs-build:
 
 ``build``
-""""""""
+"""""""""
 
 **Type:** ``Literal["true", "false"]``
 
@@ -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.15.0
       with:
         root_options: "-vv --noop"
 
@@ -438,7 +438,7 @@ and any actions that were taken.
 .. _gh_actions-psr-outputs-is_prerelease:
 
 ``is_prerelease``
-""""""""""""""""
+"""""""""""""""""
 
 **Type:** ``Literal["true", "false"]``
 
@@ -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.15.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.15.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.15.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.15.0
      with:
        directory: ./project2
        github_token: ${{ secrets.GITHUB_TOKEN }}

{python_semantic_release-9.13.0 → python_semantic_release-9.15.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:**
@@ -537,7 +557,7 @@ author, you are free to customize how these are presented in the rendered templa
 
 .. note::
    If you are using a custom commit parser following the guide at
-   :ref:`commit-parser-writing-your-own-parser`, your custom implementations of
+   :ref:`commit_parser-custom_parser`, your custom implementations of
    :py:class:`ParseResult <semantic_release.commit_parser.token.ParseResult>`,
    :py:class:`ParseError <semantic_release.commit_parser.token.ParseError>`
    and :py:class:`ParsedCommit <semantic_release.commit_parser.token.ParsedCommit>`
@@ -549,7 +569,7 @@ are of type :py:class:`Version <semantic_release.version.version.Version>`. You
 use the ``as_tag()`` method to render these as the Git tag that they correspond to
 inside your template.
 
-A :py:class:`Release <semantic_release.changelog.release_history.Release>`object
+A :py:class:`Release <semantic_release.changelog.release_history.Release>` object
 has an ``elements`` attribute, which has the same structure as the ``unreleased``
 attribute of a
 :py:class:`ReleaseHistory <semantic_release.changelog.release_history.ReleaseHistory>`;
@@ -572,7 +592,8 @@ type, it's recommended to use Jinja's
 `dictsort <https://jinja.palletsprojects.com/en/3.1.x/templates/#jinja-filters.dictsort>`_
 filter.
 
-Each ``Release`` object also has the following attributes:
+Each :py:class:`Release <semantic_release.changelog.release_history.Release>`
+object also has the following attributes:
 
 * ``tagger: git.Actor``: The tagger who tagged the release.
 
@@ -581,8 +602,8 @@ Each ``Release`` object also has the following attributes:
 * ``tagged_date: datetime``: The date and time at which the release was tagged.
 
 .. seealso::
-   * :ref:`commit-parser-builtin`
-   * :ref:`Commit Parser Tokens <commit-parser-tokens>`
+   * :ref:`commit_parser-builtin`
+   * :ref:`Commit Parser Tokens <commit_parser-tokens>`
    * `git.Actor <https://gitpython.readthedocs.io/en/stable/reference.html#git.objects.util.Actor>`_
    * `datetime.strftime Format Codes <https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes>`_
 
@@ -612,6 +633,8 @@ The filters provided vary based on the VCS configured and available features:
 
       {{ "This is a long string that needs to be wrapped to a specific width" | autofit_text_width(40, 4) }}
 
+  **Markdown Output:**
+
   .. code:: markdown
 
       This is a long string that needs to be
@@ -649,6 +672,8 @@ The filters provided vary based on the VCS configured and available features:
       {{ "example/repo.git" | create_server_url }}
       {{ "example/repo" | create_server_url(None, "results=1", "section-header") }}
 
+  **Markdown Output:**
+
   .. code:: markdown
 
       https://example.com/example/repo.git
@@ -670,6 +695,8 @@ The filters provided vary based on the VCS configured and available features:
       {{ "releases/tags/v1.0.0" | create_repo_url }}
       {{ "issues" | create_repo_url("q=is%3Aissue+is%3Aclosed") }}
 
+  **Markdown Output:**
+
   .. code:: markdown
 
       https://example.com/example/repo/releases/tags/v1.0.0
@@ -686,6 +713,8 @@ The filters provided vary based on the VCS configured and available features:
 
       {{ commit.hexsha | commit_hash_url }}
 
+  **Markdown Output:**
+
   .. code:: markdown
 
       https://example.com/example/repo/commit/a1b2c3d435657f5d339ba10c7b1ed81b460af51d
@@ -702,13 +731,15 @@ The filters provided vary based on the VCS configured and available features:
 
       {{ "v1.0.0" | compare_url("v1.1.0") }}
 
+  **Markdown Output:**
+
   .. code:: markdown
 
       https://example.com/example/repo/compare/v1.0.0...v1.1.0
 
 * ``issue_url (Callable[[IssueNumStr | IssueNumInt], UrlStr])``: given an issue
   number, return a URL to the issue on the remote vcs. In v9.12.2, this filter
-  was updated to handle a string that has leading prefix symbols (ex. ``#29``)
+  was updated to handle a string that has leading prefix symbols (ex. ``#32``)
   and will strip the prefix before generating the URL.
 
   *Introduced in v9.6.0, Modified in v9.12.2.*
@@ -717,11 +748,19 @@ The filters provided vary based on the VCS configured and available features:
 
   .. code:: jinja
 
-      {{ "29" | issue_url }}
+      {# Add Links to issues annotated in the commit message
+       # NOTE: commit.linked_issues is only available in v9.15.0 or greater
+       #
+      #}{% for issue_ref in commit.linked_issues
+      %}{{     "- [%s](%s)" | format(issue_ref, issue_ref | issue_url)
+      }}{% endfor
+      %}
+
+  **Markdown Output:**
 
   .. code:: markdown
 
-      https://example.com/example/repo/issues/29
+      - [#32](https://example.com/example/repo/issues/32)
 
 * ``merge_request_url (Callable[[MergeReqStr | MergeReqInt], UrlStr])``: given a
   merge request number, return a URL to the merge request in the remote. This is
@@ -744,6 +783,8 @@ The filters provided vary based on the VCS configured and available features:
       }}
       {# commit.linked_merge_request is only available in v9.13.0 or greater #}
 
+  **Markdown Output:**
+
   .. code:: markdown
 
       [#29](https://example.com/example/repo/-/merge_requests/29)
@@ -761,13 +802,16 @@ The filters provided vary based on the VCS configured and available features:
 
   .. code:: jinja
 
-      {{
+      {# Create a link to the merge request associated with the commit
+       # NOTE: commit.linked_merge_request is only available in v9.13.0 or greater
+      #}{{
           "[%s](%s)" | format(
             commit.linked_merge_request,
             commit.linked_merge_request | pull_request_url
           )
       }}
-      {# commit.linked_merge_request is only available in v9.13.0 or greater #}
+
+  **Markdown Output:**
 
   .. code:: markdown