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

{python_semantic_release-9.12.2/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.12.2
+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.12.2 → 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.12.2
+    - 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.12.2
+            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.12.2
+    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.12.2
+     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.12.2
+     uses: python-semantic-release/python-semantic-release@v9.14.0
      with:
        directory: ./project2
        github_token: ${{ secrets.GITHUB_TOKEN }}

{python_semantic_release-9.12.2 → 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:**
@@ -512,60 +532,72 @@ the ``context`` object has the following attributes:
 Release History
 """""""""""""""
 
-A ``ReleaseHistory`` object has two attributes: ``released`` and ``unreleased``.
+A :py:class:`ReleaseHistory <semantic_release.changelog.release_history.ReleaseHistory>`
+object has two attributes: ``released`` and ``unreleased``.
 
 The ``unreleased`` attribute is of type ``Dict[str, List[ParseResult]]``. Each commit
 in the current branch's commit history since the last release on this branch is grouped
-by the ``type`` attribute of the ``ParsedCommit`` returned by the commit parser,
-or if the parser returned a ``ParseError`` then the result is grouped under the
-``"unknown"`` key.
+by the ``type`` attribute of the
+:py:class:`ParsedCommit <semantic_release.commit_parser.token.ParsedCommit>`
+returned by the commit parser, or if the parser returned a
+:py:class:`ParseError <semantic_release.commit_parser.token.ParseError>`
+then the result is grouped under the ``"unknown"`` key.
 
 For this reason, every element of ``ReleaseHistory.unreleased["unknown"]`` is a
-``ParseError``, and every element of every other value in ``ReleaseHistory.unreleased``
-is of type ``ParsedCommit``.
+:py:class:`ParseError <semantic_release.commit_parser.token.ParseError>`, and
+every element of every other value in ``ReleaseHistory.unreleased`` is of type
+:py:class:`ParsedCommit <semantic_release.commit_parser.token.ParsedCommit>`.
 
 Typically, commit types will be ``"feature"``, ``"fix"``, ``"breaking"``, though the
 specific types are determined by the parser. For example, the
-:py:class:`semantic_release.commit_parser.EmojiCommitParser` uses a textual
-representation of the emoji corresponding to the most significant change introduced
-in a commit (e.g. ``":boom:"``) as the different commit types. As a template author,
-you are free to customise how these are presented in the rendered template.
+:py:class:`EmojiCommitParser <semantic_release.commit_parser.emoji.EmojiCommitParser>`
+uses a textual representation of the emoji corresponding to the most significant change
+introduced in a commit (e.g. ``":boom:"``) as the different commit types. As a template
+author, you are free to customize how these are presented in the rendered template.
 
 .. note::
    If you are using a custom commit parser following the guide at
    :ref:`commit-parser-writing-your-own-parser`, your custom implementations of
-   :py:class:`semantic_release.ParseResult`, :py:class:`semantic_release.ParseError`
-   and :py:class:`semantic_release.ParsedCommit` will be used in place of the built-in
-   types.
+   :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>`
+   will be used in place of the built-in types.
 
 The ``released`` attribute is of type ``Dict[Version, Release]``. The keys of this
 dictionary correspond to each version released within this branch's history, and
-are of type ``semantic_release.Version``. You can use the ``as_tag()`` method to
-render these as the Git tag that they correspond to inside your template.
-
-A ``Release`` object has an ``elements`` attribute, which has the same
-structure as the ``unreleased`` attribute of a ``ReleaseHistory``; that is,
-``elements`` is of type ``Dict[str, List[ParseResult]]``, where every element
-of ``elements["unknown"]`` is a ``ParseError``, and elements of every other
-value correspond to the ``type`` attribute of the ``ParsedCommit`` returned
+are of type :py:class:`Version <semantic_release.version.version.Version>`. You can
+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
+has an ``elements`` attribute, which has the same structure as the ``unreleased``
+attribute of a
+:py:class:`ReleaseHistory <semantic_release.changelog.release_history.ReleaseHistory>`;
+that is, ``elements`` is of type ``Dict[str, List[ParseResult]]``, where every element
+of ``elements["unknown"]`` is a
+:py:class:`ParseError <semantic_release.commit_parser.token.ParseError>`, and elements
+of every other value correspond to the ``type`` attribute of the
+:py:class:`ParsedCommit <semantic_release.commit_parser.token.ParsedCommit>` returned
 by the commit parser.
 
 The commits represented within each ``ReleaseHistory.released[version].elements``
-grouping are the commits which were made between ``version`` and the release
-corresponding to the previous version.
-That is, given two releases ``Version(1, 0, 0)`` and ``Version(1, 1, 0)``,
-``ReleaseHistory.released[Version(1, 0, 0)].elements`` contains only commits
-made after the release of ``Version(1, 0, 0)`` up to and including the release
-of ``Version(1, 1, 0)``.
+grouping are the commits which were made between version and the release corresponding
+to the previous version. That is, given two releases ``Version(1, 0, 0)`` and
+``Version(1, 1, 0)``, ``ReleaseHistory.released[Version(1, 0, 0)].elements`` contains
+only commits made after the release of ``Version(1, 0, 0)`` up to and including the
+release of ``Version(1, 1, 0)``.
 
 To maintain a consistent order of subsections in the changelog headed by the commit
-type, it's recommended to use Jinja's `dictsort <https://jinja.palletsprojects.com/en/3.1.x/templates/#jinja-filters.dictsort>`_
+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:
 
 * ``tagger: git.Actor``: The tagger who tagged the release.
+
 * ``committer: git.Actor``: The committer who made the release commit.
+
 * ``tagged_date: datetime``: The date and time at which the release was tagged.
 
 .. seealso::
@@ -724,11 +756,17 @@ The filters provided vary based on the VCS configured and available features:
 
   .. code:: jinja
 
-      {{ "29" | merge_request_url }}
+      {{
+          "[%s](%s)" | format(
+            commit.linked_merge_request,
+            commit.linked_merge_request | merge_request_url
+          )
+      }}
+      {# commit.linked_merge_request is only available in v9.13.0 or greater #}
 
   .. code:: markdown
 
-      https://example.com/example/repo/-/merge_requests/29
+      [#29](https://example.com/example/repo/-/merge_requests/29)
 
 * ``pull_request_url (Callable[[PullReqStr | PullReqInt], UrlStr])``: given a pull
   request number, return a URL to the pull request in the remote. For remote vcs'
@@ -743,11 +781,17 @@ The filters provided vary based on the VCS configured and available features:
 
   .. code:: jinja
 
-      {{ "29" | pull_request_url }}
+      {{
+          "[%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 #}
 
   .. code:: markdown
 
-      https://example.com/example/repo/pull/29
+      [#29](https://example.com/example/repo/pull/29)
 
 * ``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
@@ -883,12 +927,12 @@ exposed to the `Jinja`_ template when rendering the release notes.
 
 Additionally, the following two globals are available to the template:
 
-* ``release`` (:class:`Release <semantic_release.changelog.release_history.Release>`):
+* ``release`` (:py:class:`Release <semantic_release.changelog.release_history.Release>`):
   contains metadata about the content of the release, as parsed from commit logs
 
   *Introduced in v8.0.0.*
 
-* ``version`` (:class:`Version <semantic_release.version.version.Version>`): contains
+* ``version`` (:py:class:`Version <semantic_release.version.version.Version>`): contains
   metadata about the software version to be released and its ``git`` tag
 
   *Introduced in v8.0.0.*

{python_semantic_release-9.12.2 → python_semantic_release-9.14.0}/docs/commit-parsing.rst

@@ -45,9 +45,12 @@ The following parsers are built in to Python Semantic Release:
 ``semantic_release.commit_parser.AngularCommitParser``
 """"""""""""""""""""""""""""""""""""""""""""""""""""""
 
-The default parser, which uses the `Angular commit style <https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits>`_ with the following differences:
+The default parser, which uses the
+`Angular commit style <https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits>`_
+with the following differences:
 
   - Multiple ``BREAKING CHANGE:`` paragraphs are supported
+
   - ``revert`` is not currently supported
 
 The default configuration options for
@@ -222,26 +225,41 @@ as the commit history of a repository is being parsed. Python Semantic Release d
 not raise an exception if a commit cannot be parsed.
 
 Python Semantic Release uses :py:class:`semantic_release.ParsedCommit`
-as the return type of a successful parse operation, and :py:class:`semantic_release.ParseError`
-as the return type from an unsuccessful parse of a commit. :py:class:`semantic_release.ParsedCommit` is a `namedtuple`_ which has the following fields:
-
-* bump: a :py:class:`semantic_release.LevelBump` indicating what type of change this commit introduces.
-* type: the *type* of the commit as a string, per the commit message style. This is up to the
-  parser to implement; for example, the :py:class:`semantic_release.commit_parser.EmojiCommitParser`
-  parser fills this field with the emoji representing the most significant change for the commit.
-  The field is named after the representation in the Angular commit specification.
-* scope: The scope, as a string, parsed from the commit. Commit styles which do not have a meaningful
-  concept of "scope" should fill this field with an empty string.
-* descriptions: A list of paragraphs (strings) (delimited by a double-newline) from the commit message.
-* breaking_descriptions: A list of paragraphs (strings) which are deemed to identify and describe
-  breaking changes by the parser. An example would be a paragraph which begins with the text
-  ``BREAKING CHANGE:``.
-* commit: The original commit object that was parsed.
+as the return type of a successful parse operation, and
+:py:class:`semantic_release.ParseError` as the return type from an unsuccessful
+parse of a commit. :py:class:`semantic_release.ParsedCommit` is a `namedtuple`_
+which has the following fields:
+
+* **bump**: a :py:class:`semantic_release.LevelBump` indicating what type of change
+  this commit introduces.
+
+* **type**: the *type* of the commit as a string, per the commit message style. This
+  is up to the parser to implement; for example, the
+  :py:class:`semantic_release.commit_parser.EmojiCommitParser` parser fills this field
+  with the emoji representing the most significant change for the commit. The field is
+  named after the representation in the Angular commit specification.
+
+* **scope**: The scope, as a string, parsed from the commit. Commit styles which do
+  not have a meaningful concept of "scope" should fill this field with an empty string.
+
+* **descriptions**: A list of paragraphs (strings) (delimited by a double-newline)
+  from the commit message.
+
+* **breaking_descriptions**: A list of paragraphs (strings) which are deemed to
+  identify and describe breaking changes by the parser. An example would be a
+  paragraph which begins with the text ``BREAKING CHANGE:``.
+
+* **commit**: The original commit object (a class defined by GitPython) that was parsed.
+
+* **linked_merge_request**: A pull request or merge request definition, if the commit is
+  labeled with a pull/merge request number. This is a string value which includes any
+  special character prefix used by the VCS (e.g. ``#`` for GitLab, ``!`` for Bitbucket).
 
 :py:class:`semantic_release.ParseError` is a `namedtuple`_ which has the following fields:
 
-* commit: The original commit object that was parsed.
-* error: A string with a meaningful error message as to why the commit parsing failed.
+* **commit**: The original commit object that was parsed.
+
+* **error**: A string with a meaningful error message as to why the commit parsing failed.
 
 In addition, :py:class:`semantic_release.ParseError` implements an additional method, ``raise_error``.
 This method raises a :py:class:`semantic_release.CommitParseError` with the message contained in the
@@ -252,10 +270,12 @@ attributes available, each implemented as a ``property`` which is computed, as a
 convenience for template authors - therefore custom implementations should ensure
 these properties can also be computed:
 
-* message: the ``message`` attribute of the ``commit``; where the message is of type ``bytes``
-  this should be decoded to a ``UTF-8`` string.
-* hexsha: the ``hexsha`` attribute of the ``commit``, representing its hash.
-* short_hash: the first 7 characters of the ``hexsha`` attribute of the ``commit``.
+* **message**: the ``message`` attribute of the ``commit``; where the message is of type
+  ``bytes`` this should be decoded to a ``UTF-8`` string.
+
+* **hexsha**: the ``hexsha`` attribute of the ``commit``, representing its hash.
+
+* **short_hash**: the first 7 characters of the ``hexsha`` attribute of the ``commit``.
 
 In Python Semantic Release, the class :py:class:`semantic_release.ParseResult`
 is defined as ``ParseResultType[ParsedCommit, ParseError]``, as a convenient shorthand.
@@ -268,7 +288,9 @@ type returned on an unsuccessful parse of the ``commit``.
 A custom parser result type, therefore, could be implemented as follows:
 
 * ``MyParsedCommit`` subclasses ``ParsedCommit``
+
 * ``MyParseError`` subclasses ``ParseError``
+
 * ``MyParseResult = ParseResultType[MyParsedCommit, MyParseError]``
 
 Internally, Python Semantic Release uses ``isinstance`` to determine if the result
@@ -326,8 +348,10 @@ the following:
 
 * A class-level attribute ``parser_options``, which must be set to
   :py:class:`semantic_release.ParserOptions` or a subclass of this.
+
 * An ``__init__`` method which takes a single parameter, ``options``, that should be
   of the same type as the class' ``parser_options`` attribute.
+
 * A method, ``parse``, which takes a single parameter ``commit`` that is of type
   `git.objects.commit.Commit <gitpython-commit-object>`_, and returns
   :py:class:`semantic_release.token.ParseResult`, or a subclass of this.

{python_semantic_release-9.12.2 → python_semantic_release-9.14.0}/docs/conf.py

@@ -38,7 +38,7 @@ htmlhelp_basename = "python-semantic-releasedoc"
 
 docs_path = os.path.dirname(__file__)
 apidoc_output_dir = os.path.join(docs_path, "api")
-apidoc_module_dir = os.path.join(docs_path, "..", "semantic_release")
+apidoc_module_dir = os.path.join(docs_path, "..", "src")
 apidoc_separate_modules = True
 apidoc_module_first = True
 apidoc_extra_args = ["-d", "3"]

{python_semantic_release-9.12.2 → 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.12.2 → 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.12.2 → python_semantic_release-9.14.0}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-semantic-release"
-version = "9.12.2"
+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.12.2 → 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.12.2
+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.12.2 → python_semantic_release-9.14.0}/src/python_semantic_release.egg-info/SOURCES.txt

@@ -68,6 +68,8 @@ 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
 src/semantic_release/data/templates/angular/rst/CHANGELOG.rst.j2
@@ -75,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
@@ -127,6 +130,7 @@ tests/fixtures/repos/git_flow/__init__.py
 tests/fixtures/repos/git_flow/repo_w_2_release_channels.py
 tests/fixtures/repos/git_flow/repo_w_3_release_channels.py
 tests/fixtures/repos/github_flow/__init__.py
+tests/fixtures/repos/github_flow/repo_w_default_release.py
 tests/fixtures/repos/github_flow/repo_w_release_channels.py
 tests/fixtures/repos/trunk_based_dev/__init__.py
 tests/fixtures/repos/trunk_based_dev/repo_w_no_tags.py
@@ -137,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.12.2 → 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.12.2 → 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.12.2"
+__version__ = "9.14.0"
 
 __all__ = [
     "CommitParser",

{python_semantic_release-9.12.2 → 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.12.2 → 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.12.2 → 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.12.2 → 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.12.2 → 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,