chore(deps): update python-semantic-release/python-semantic-release action to v9.12.0

[renovate]

This PR contains the following updates:

Package	Type	Update	Change
python-semantic-release/python-semantic-release	action	minor	v9.9.0 -> v9.12.0

---

Release Notes

python-semantic-release/python-semantic-release (python-semantic-release/python-semantic-release)

v9.12.0

Compare Source

Bug Fixes

• fix(parser-emoji): enable the default bump level option (bc27995)

• fix(changelog): ignore commit exclusion when a commit causes a version bump (e8f886e)

• fix(parser-angular): change Fixes commit type heading to Bug Fixes (#​1064)

• test(fixtures): update expected changelog heading to Bug Fixes

• test(unit): update expected changelog heading to Bug Fixes (09e3a4d)

Documentation

• docs(configuration): add deprecation message for the tag parser (a83b7e4)

• docs(commit-parsers): add deprecation message for the tag parser (af94540)

Features

• feat(changelog): add autofit_text_width filter to template environment (#​1062)

This change adds an equivalent style formatter that can apply a text alignment
to a maximum width and also maintain an indent over paragraphs of text

• docs(changelog-templates): add definition & usage of autofit_text_width template filter

• test(changelog-context): add test cases to check autofit_text_width filter use (83e4b86)

v9.11.1

Compare Source

Bug Fixes

• fix(changelog): prevent custom template errors when components are in hidden folders (#​1060) (a7614b0)

v9.11.0

Compare Source

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)

v9.10.1

Compare Source

Fixes

• fix(config): handle branch match regex errors gracefully (#​1054)

prevents stacktrace error when user provided regex for a branch name match
is invalid. Translates most common failure of a plain wildcard * character to
the implied proper regex (4d12251)

v9.10.0

Compare Source

Documentation

• docs(github-actions): update primary example with workflow sha controlled pipeline (14f04df)

Features

• feat(changelog): modify changelog template to support changelog updates (#​1045)

• feat(changelog): add read_file function to changelog template context

  This feature adds a filter that will enable jinja templates to read a file
  from the repository into memory to then use as output within the template.
  The primary use for this is to read in a previous changelog file which then
  the template can give the illusion of insertion as it re-writes the entire
  file.

• feat(changelog): add changelog_mode to changelog template context

  Adds a flag that can be passed to the templating environment to allow
  for triggering an update mode of a changelog versions an initialization
  mode. The usage is up to the template developer but for PSR it is used
  to handle changelog generation vs changelog updating.

• feat(changelog): add prev_changelog_file to changelog template context

  This adds a string that represents a filename to a previous changelog file
  which can be read from inside the template context. The primary use is for
  enabling the updating of a changelog through jinja templating.

• feat(changelog): add changelog_insertion_flag to changelog template context

  This adds a customizable string to the jinja templating context which allows users
  to use the PSR configuration to pass a custom insertion flag into the templating
  context. This is intended for use with initializing a changelog and then updating
  it from that point forward.

• feat(changelog): add shorthand ctx variable to changelog template env

• refactor(changelog): change recursive render to not use file streaming

  It would be nice to maintain file streaming for better memory usage but it
  prevents the ability to read the file contents previously from within the
  template which is a desire in order to insert into a previous changelog.
  In this case, the memory usage is likely not a problem for large text files.

• fix(config): prevent jinja from autoescaping markdown content by default

  Since this project is generally rendering non-html content such as RST or MD,
  change the default of the jinja autoescape parameter to false instead of true.
  When it was true, it would automatically convert any & ampersands to its
  htmlentity equivalent & which is completely unnecessary and unreadable in
  non-html documents.

• docs(configuration): update changelog.environment.autoescape default to false to match code

• docs(configuration): standardize all true/false to lowercase ensuring toml-compatibility

• feat(config): add changelog.mode as configuration option

• feat(config): add changelog.insertion_flag as configuration option

• refactor(config): use changelog.changelog_file as previous changelog file for target for update

• style(config): alphabetize changelog configuration options

• docs(configuration): add changelog.mode and changelog.insertion_flag config definitions

• fix(changelog): adjust angular heading names for readability

• feat(changelog): modify changelog template to support changelog updates

  By popular demand, the desire to only prepend new information to the changelog
  is now possible given the changelog.mode = update configuration option.

  Resolves: #​858, #​722

• refactor(errors): add new generic internal error for tragic improbable flaws

• fix(changelog): ensure changelog templates can handle complex directory includes

• feat(config): add changelog.default_templates.output_format config option

• fix(changelog): only render user templates when files exist

  This change ensures that we will use our default even when the user only overrides
  the release notes template. It also must have jinja templates in the folder otherwise
  we will render the default changelog.

• refactor(changelog): enable default changelog rendering of multiple template parts

• refactor(changelog): change rendering of default release notes to new template structure

• refactor(context): use pathlib instead of context manager to read file

• test(fixtures): update changelog generator format & angular heading names

• test(angular): adjust test of commit type to section header

• test(changelog): update make changelog context function call

• test(release-notes): update test related to release notes generation

• test(fixtures): add processing to filter out repo definitions for partial changelogs

• test(fixtures): update repo generators to update changelogs w/ every version

• test(fixtures): slow down repo generators to prevent git failures from same timestamps

• test(fixtures): update changelog generator to include insertion flag

• refactor(changelog): fix template to handle update when no releases exist

• refactor(changelog): adjust template to use improved release object

• refactor(changelog): improve resilence & non-existant initial changelog

• style(changelog-templates): maintain 2-spaces indentation throughout jinja templates

• refactor(changelog): ensure cross-platform template includes with jinja compatibility

• test(changelog-cmd): add tests to evaluate variations of the changelog update mode

• test(version-cmd): add tests to evaluate variations of the changelog update mode

• refactor(release-notes): normalize line endings to universal newlines & always end with newline

• refactor(changelog): ensure default changelog renders w/ universal newlines & writes as os-specific

• test(changelog): update changelog testing implementation to be newline aware

• test: update tests to use cross-platform newlines where appropriate

• docs(changelog-templates): improve detail & describe new changelog.mode="update"

• docs(configuration): mark version of configuration setting introduction

• docs(homepage): update custom changelog reference

• refactor(changelog): adjust read_file filter to read file as os-newline aware

• refactor(changelog): apply forced universal newline normalizer on default changelog

• test(changelog): adjust implementation to consistently work on windows

• test(version): adjust implementation to consistently work on windows

• refactor(changelog-template): only add insertion flag if in update mode

• test(changelog): adjust test to handle changelog regeneration in init mode

• refactor(changelog-templates): adjust init template to clean up extra newlines

• test(changelog): adjust expected output after cleaned up newlines

• docs(configuration): define the new changelog.default_templates.output_format option (c18c245)

• feat(github-actions): add an action build directive to toggle the --skip-build option (#​1044)

• docs(commands): update definition of the version commands --skip-build option

• docs(github-actions): add description of the build input directive (26597e2)

---

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

---

• If you want to rebase/retry this PR, check this box

---

This PR was generated by Mend Renovate. View the repository job log.

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.