9.11.0

Automatically generated by python-semantic-release

Author: semantic-release

CHANGELOG.md

@@ -1,6 +1,61 @@
 # CHANGELOG
 
 
+## v9.11.0 (2024-10-12)
+
+### Features
+
+* feat(changelog): add default changelog template in reStructuredText format (#1055)
+
+* test(fixtures): update repo generation to create rst & md changelogs
+
+* test(release-history): refactor fragile test to utilize repo fixture definitions
+
+* test(changelog-cmd): update tests to evaluate rst changelog generation & updates
+
+* test(version-cmd): update tests to evaluate rst changelog generation & updates
+
+* test(version-cmd): update test code to match new commit definition functions
+
+* test(config): add test to validate `insertion_flag` default determination
+
+* feat(changelog): add `convert_md_to_rst` filter to changelog environment
+
+* feat(changelog): add default changelog in re-structured text format
+
+  This change adds the templates to create an equivalent CHANGELOG.RST file in
+  angular changelog style. It can be enabled via the `output_format` configuration
+  setting.
+
+  Resolves: #399
+
+* feat(config): enable target changelog filename to trigger RST output format
+
+  Resolves: #399
+
+* feat(config): enable default `changelog.insertion_flag` based on output format
+
+* refactor(config): move `changelog_file` setting under `changelog.default_templates`
+
+  This change adds a secondary `changelog_file` setting under the default_templates
+  section while deprecating the top level one. Since this is not intended to be a
+  breaking change we provided a warning message and compatibility code to pass along
+  the current `changelog_file` value to the new setting location while giving the user
+  a notification to update before the next version.
+
+* fix(changelog): correct spacing for default markdown template during updates
+
+* docs(configuration): update details of `insertion_flag`'s dynamic defaults with rst
+
+* docs(configuration): update `output_format` description for reStructuredText support
+
+* docs(configuration): update `changelog_file` with deprecation notice of setting relocation
+
+* docs(changelog): clarify the `convert_md_to_rst` filter added to the template environment
+
+* docs(changelog): increase detail about configuration options of default changelog creation ([`c2e8831`](https://github.com/python-semantic-release/python-semantic-release/commit/c2e883104d3c11e56f229638e988d8b571f86e34))
+
+
 ## v9.10.1 (2024-10-10)
 
 ### Fixes

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.10.1
+    - uses: python-semantic-release/python-semantic-release@v9.11.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.10.1
+            uses: python-semantic-release/python-semantic-release@v9.11.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.10.1
+    uses: python-semantic-release/python-semantic-release@v9.11.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.10.1
+     uses: python-semantic-release/python-semantic-release@v9.11.0
      with:
        directory: ./project1
        github_token: ${{ secrets.GITHUB_TOKEN }}
 
    - name: Release Project 2
-     uses: python-semantic-release/python-semantic-release@v9.10.1
+     uses: python-semantic-release/python-semantic-release@v9.11.0
      with:
        directory: ./project2
        github_token: ${{ secrets.GITHUB_TOKEN }}

pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-semantic-release"
-version = "9.10.1"
+version = "9.11.0"
 description = "Automatic Semantic Versioning for Python projects"
 requires-python = ">=3.8"
 license = { text = "MIT" }

semantic_release/__init__.py

@@ -24,7 +24,7 @@
     tags_and_versions,
 )
 
-__version__ = "9.10.1"
+__version__ = "9.11.0"
 
 __all__ = [
     "CommitParser",