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.8.1 -> 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)

v9.9.0

Compare Source

Documentation

• docs(github-actions): clarify & consolidate GitHub Actions usage docs (#​1011)

  Resolves: #​907

• chore(scripts): remove non-existant file from version bump script

• docs(automatic-releases): drop extrenous github push configuration

• docs(homepage): remove link to old github config & update token scope config

• docs(github-actions): expand descriptions & clarity of actions configs

• docs(github-actions): add configuration & description of publish action

• docs(github-actions): revert removal of namespace prefix from examples (2135c68)

Features

• feat(github-actions): add is_prerelease output to the version action (#​1038)

• test(github-actions): add test to ensure is_prerelease is a action output

• docs(github-actions): add description of new is_prerelease output for version action (6a5d35d)

v9.8.9

Compare Source

Documentation

• docs: update docstrings to resolve sphinx failures (#​1030)

set ignore-module-all for autodoc_default_options to resolve some
Sphinx errors about duplicate / ambiguous references
https://github.com/sphinx-doc/sphinx/issues/4961#issuecomment-1543858623

Standardize some non-standard (Google-ish) docstrings to Sphinx
format, to avoid ruff and Sphinx arguing about underline length.

Fix indents and other minor whitespace / formatting changes.

Fixes #​1029 (d84efc7)

Fixes

• fix(version-cmd): improve version_variables flexibility w/ quotes (ie. json, yaml, etc) (#​1028)

• fix(version-cmd): increase version_variable flexibility with quotations (ie. json, yaml, etc)

  Previously json would not work due to the key being wrapped in quotes, yaml also has issues
  when it does not usually use quotes. The regex we created originally only wrapped the version
  to be replaced in quotes but now both the key and version can optionally be wrapped in
  different kind of quotations.

  Resolves: #​601, #​706, #​962, #​1026

• docs(configuration): add clarity to version_variables usage & limitations

  Ref: #​941

• fix(version-cmd): ensure version_variables do not match partial variable names

• build(deps-test): add PyYAML as a test dependency

• test(fixtures): refactor location of fixture for global use of cli runner

• test(stamp-version): add test cases to stamp json, python, & yaml files (156915c)

v9.8.8

Compare Source

Bug Fixes

• fix(config): fix path traversal detection for windows compatibility (#​1014)

  The original implementation of the path traversal detection expected that resolve()
  works the same on windows as it does with Linux/Mac. Windows requires the folder paths
  to exist to be resolved and that is not the case when the template_dir is not being
  used.

  Resolves: #​994 (16e6daa)

Documentation

• docs(configuration): update build_command env table for windows to use all capital vars (0e8451c)

• docs(github-actions): update version in examples to latest version (3c894ea)

v9.8.7

Compare Source

Bug Fixes

• fix: provide context.history global in release notes templates (#​1005)

• fix(release-notes): provide context.history global in release note templates

  Temporarily return the context.history variable to release notes generation
  as many users are using it in their release documentation. It was never intended
  to be provided and will be removed in the future.

  context was removed in v9.8.3 during a refactor and condensing of changelog
  and release notes functionality.

  Resolves: #​984

• fix(release-notes): fix noop-changelog to print raw release notes

  Some markdown sequences can be interpreted as ansi escape sequences which dilute
  debugging of release note templates by the user. This change ensures the raw
  content is displayed to the console as expected. (5bd91b4)

Documentation

• docs: use pinned version for GHA examples (#​1004)

• docs(github-actions): use pinned version for GHA examples

  Fixes #​1003

• chore(scripts): add auto version bump to non dynamic docs text (i.e. code snippets)

• docs(github-actions): adjust formatting & version warning in code snippets

• style(docs-github-actions): adjust formatting for readability

---

Co-authored-by: codejedi365 <codejedi365@​gmail.com> (5fdf761)

• docs(configuration): fix build_command_env table rendering (#​996) (a5eff0b)

• docs(changelog): clarify description of the default changelog generation process (399fa65)

• docs(configuration): clarify changelog_file vs template_dir option usage

Provided additional description that warns about the mutually-exclusive nature of
the changelog_file option and the template_dir option.

Resolves: #​983 (a7199c8)

v9.8.6

Compare Source

Bug Fixes

• fix(version-cmd): resolve build command execution in powershell (#​980)

Fixes the command line option for passing a shell command to Powershell. Also included a similar shell detection result for
pwsh (Powershell Core) (32c8e70)

Documentation

• docs(configuration): correct GHA parameter name for commit email (#​981)

git_committer_name was repeated; replace one instance of it with
git_committer_email (ce9ffdb)

v9.8.5

Compare Source

Bug Fixes

• fix: enable --print-last-released* when in detached head or non-release branch (#​926)

• test(version-cmd): add tests to print when detached or non-release branch

  ref: #​900

• fix(version-cmd): drop branch restriction for --print-last-released* opts

  Resolves: #​900 (782c0a6)

Performance Improvements

• perf: improve git history processing for changelog generation (#​972)

• perf(changelog): improve git history parser changelog generation

  This converts the double for-loop (O(n^2)) down to O(n) using a
  lookup table to match the current commit with a known tag rather than
  iterating through all the tags of the repository every time.

• fix(changelog): resolve commit ordering issue when dates are similar (bfda159)

v9.8.4

Compare Source

Bug Fixes

• fix(changelog-cmd): remove usage strings when error occured

Resolves: #​810 (348a51d)

• fix(publish-cmd): remove usage strings when error occured

Resolves: #​810 (afbb187)

• fix(config): prevent path traversal manipulation of target changelog location (43e35d0)

• fix(version-cmd): remove usage strings when error occurred

Resolves: #​810 (a7c17c7)

• fix(publish-cmd): prevent error when provided tag does not exist locally (16afbbb)

• fix(config): prevent path traversal manipulation of target changelog location (3eb3dba)

• fix(changelog-cmd): render default changelog when user template directory exist but is empty (bded8de)

v9.8.3

Compare Source

Bug Fixes

• fix(parser): strip DOS carriage-returns in commits (#​956)

The default template can result in mixed (UNIX / DOS style) carriage
returns in the generated changelog. Use a string replace in the commit
parser to strip the DOS CRs ("\r"). This is only needed in the case when
we are not byte decoding.

Fixes #​955 (0b005df)

v9.8.2

Compare Source

Bug Fixes

• fix(templates): suppress extra newlines in default changelog (#​954)

  Suppress extra newlines in default generated changelog output (7b0079b)

---

Configuration

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

🚦 Automerge: Enabled.

♻ Rebasing: Whenever PR is behind base branch, 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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 51.14%. Comparing base (307c3f0) to head (9f373b6).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #62   +/-   ##
=======================================
  Coverage   51.14%   51.14%           
=======================================
  Files           6        6           
  Lines         614      614           
  Branches      112      112           
=======================================
  Hits          314      314           
  Misses        275      275           
  Partials       25       25           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.