chore(deps): update python-semantic-release/python-semantic-release action to v10

[renovate]

This PR contains the following updates:

Package	Type	Update	Change
python-semantic-release/python-semantic-release	action	major	v9.21.1 -> v10.4.0

---

Release Notes

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

v10.4.0

Compare Source

====================

✨ Features

• config: Add conventional-monorepo as valid commit_parser type (PR#1143, e18f866)

• parser: Add new conventional-commits standard parser for monorepos, closes #614_
  (PR#1143, e18f866)

📖 Documentation

• Add configuration guide for monorepo use with PSR (PR#1143, e18f866)

• commit-parsers: Introduce conventional commit monorepo parser options & features (PR#1143,
  e18f866)

• configuration: Update commit_parser option with new conventional-monorepo value
  (PR#1143, e18f866)

💡 Additional Release Information

• config: This release introduces a new built-in parser type that can be utilized for monorepo
  projects. The type value is conventional-monorepo and when specified it will apply the
  conventional commit parser to a monorepo environment. This parser has specialized options to help
  handle monorepo projects as well. For more information, please refer to the Monorepo Docs_.

.. _#614: #​614
.. _e18f866: e18f866
.. _Monorepo Docs: /configuration/configuration-guides/monorepos.html
.. _PR#1143: #​1143

.. _changelog-v10.3.2:

v10.3.2

Compare Source

====================

🪲 Bug Fixes

• cmd-version: Prevent errors when PSR is executed in non-GitHub CI environments, closes
  #1315_ (PR#1322, 4df4be4)

⚡ Performance Improvements

• cmd-version: Re-order operations for faster parsing in version determination (PR#1310,
  63e435b)

📖 Documentation

• uv-integration: Add --no-changelog to build step to increase job speed (PR#1316,
  e1aece1)

💡 Additional Release Information

• cmd-version: Unfortunately, PSR introduced a bug in 10.3.0 when attempting to provide more CI
  outputs for GitHub Actions. It required our GitHub client interface to be loaded and even if it
  was not using GitHub CI to be run. This caused errors in Gitea and likely GitLab/Bitbucket
  environments. This change prevents that from happening but if any users pipelines were
  intentionally presenting the environment variable "GITHUB_OUTPUT" to enable action output to
  enable passing along internal outputs of PSR then their hack will no longer work after this
  change.

.. _#1315: #​1315
.. _4df4be4: 4df4be4
.. _63e435b: 63e435b
.. _e1aece1: e1aece1
.. _PR#1310: #​1310
.. _PR#1316: #​1316
.. _PR#1322: #​1322

.. _changelog-v10.3.1:

v10.3.1

Compare Source

====================

🪲 Bug Fixes

• github-actions: Refactor the action output error checking for non-release executions, closes
  #1307_ (PR#1308, 5385724)

📖 Documentation

• github-actions: Adjust docs for direct links to action example workflows, closes #1303_
  (PR#1309, 8efebe2)

.. _#1303: #​1303
.. _#1307: #​1307
.. _5385724: 5385724
.. _8efebe2: 8efebe2
.. _PR#1308: #​1308
.. _PR#1309: #​1309

.. _changelog-v10.3.0:

v10.3.0

Compare Source

====================

✨ Features

• github-actions: Add commit_sha as a GitHub Actions output value, closes #717_
  (PR#1289, 39b647b)

• github-actions: Add previous_version as a GitHub Actions output value (PR#1302,
  c0197b7)

• github-actions: Add release_notes as a GitHub Actions output value (PR#1300,
  a3fd23c)

• github-actions: Add release link as a GitHub Actions output value (PR#1301, 888aea1)

🪲 Bug Fixes

• github-actions: Fix variable output newlines (PR#1300, a3fd23c)

• util: Fixes no-op log output when commit message contains square-brackets, closes #1251_
  (PR#1287, f25883f)

📖 Documentation

• getting-started: Fixes changelog.exclude_commit_patterns example in startup guide, closes
  #1291_ (PR#1292, 2ce2e94)

• github-actions: Add description of commit_sha GitHub Action output in docs (PR#1289,
  39b647b)

• github-actions: Add description of previous_release GitHub Action output (PR#1302,
  c0197b7)

• github-actions: Add description of release_notes GitHub Action output (PR#1300,
  a3fd23c)

• github-actions: Add description of release link GitHub Action output (PR#1301,
  888aea1)

• README: Update broken links to match re-located destinations (PR#1285, f4ec792)

.. _#1251: #​1251
.. _#1291: #​1291
.. _#717: #​717
.. _2ce2e94: 2ce2e94
.. _39b647b: 39b647b
.. _888aea1: 888aea1
.. _a3fd23c: a3fd23c
.. _c0197b7: c0197b7
.. _f25883f: f25883f
.. _f4ec792: f4ec792
.. _PR#1285: #​1285
.. _PR#1287: #​1287
.. _PR#1289: #​1289
.. _PR#1292: #​1292
.. _PR#1300: #​1300
.. _PR#1301: #​1301
.. _PR#1302: #​1302

.. _changelog-v10.2.0:

v10.2.0

Compare Source

====================

✨ Features

• cmd-version: Adds PACKAGE_NAME value into build command environment (db9bc13_)

📖 Documentation

• configuration: Update build command environment definition to include PACKAGE_NAME
  variable (4aa3805_)

• uv-integration: Fix configuration guide for uv usage to ensure lock file update
  (5390145_)

.. _4aa3805: 4aa3805
.. _5390145: 5390145
.. _db9bc13: db9bc13

.. _changelog-v10.1.0:

v10.1.0

Compare Source

====================

✨ Features

• cmd-version: Always stage version stamped files & changelog even with --no-commit, closes
  #1211_ (PR#1214, de62334)

📖 Documentation

• cmd-version: Improve command description & include common uses (PR#1214, de62334)

• configuration-guide: Add how-to guide for uv integration (PR#1214, de62334)

• github-actions: Clarify with examples of the root_options v10 migration change
  (PR#1271, fbb63ec)

⚙️ Build System

• deps: Expand python-gitlab dependency to include v6.0.0 (PR#1273, 99fc9cc)

.. _#1211: #​1211
.. _99fc9cc: 99fc9cc
.. _de62334: de62334
.. _fbb63ec: fbb63ec
.. _PR#1214: #​1214
.. _PR#1271: #​1271
.. _PR#1273: #​1273

.. _changelog-v10.0.2:

v10.0.2

Compare Source

====================

🪲 Bug Fixes

• github-actions: Add filesystem UID/GID fixer after action workspace modification (PR#1262,
  93e23c8)

.. _93e23c8: 93e23c8
.. _PR#1262: #​1262

.. _changelog-v10.0.1:

v10.0.1

Compare Source

====================

🪲 Bug Fixes

• github-actions: Bump the github-actions dependency to v10.0.0 (PR#1255, 2803676)

.. _2803676: 2803676
.. _PR#1255: #​1255

.. _changelog-v10.0.0:

v10.0.0

Compare Source

====================

✨ Features

• cmd-version: Enable version_variables version stamp of vars with double-equals
  (PR#1244, 080e4bc)

• parser-conventional: Set parser to evaluate all squashed commits by default (6fcdc99_)

• parser-conventional: Set parser to ignore merge commits by default (59bf084_)

• parser-emoji: Set parser to evaluate all squashed commits by default (514a922_)

• parser-emoji: Set parser to ignore merge commits by default (8a51525_)

• parser-scipy: Set parser to evaluate all squashed commits by default (634fffe_)

• parser-scipy: Set parser to ignore merge commits by default (d4f128e_)

🪲 Bug Fixes

• changelog-md: Change to 1-line descriptions in markdown template, closes #733_ (e7ac155_)

• changelog-rst: Change to 1-line descriptions in the default ReStructuredText template, closes
  #733_ (731466f_)

• cli: Adjust verbosity parameter to enable silly-level logging (bd3e7bf_)

• github-action: Resolve command injection vulnerability in action script (fb3da27_)

• parser-conventional: Remove breaking change footer messages from commit descriptions
  (b271cbb_)

• parser-conventional: Remove issue footer messages from commit descriptions (b1bb0e5_)

• parser-conventional: Remove PR/MR references from commit subject line (eed63fa_)

• parser-conventional: Remove release notice footer messages from commit descriptions
  (7e8dc13_)

• parser-emoji: Remove issue footer messages from commit descriptions (b757603_)

• parser-emoji: Remove PR/MR references from commit subject line (16465f1_)

• parser-emoji: Remove release notice footer messages from commit descriptions (b6307cb_)

• parser-scipy: Remove issue footer messages from commit descriptions (3cfee76_)

• parser-scipy: Remove PR/MR references from commit subject line (da4140f_)

• parser-scipy: Remove release notice footer messages from commit descriptions (58308e3_)

📖 Documentation

• Refactor documentation page navigation (4e52f4b_)

• algorithm: Remove out-of-date algorithm description (6cd0fbe_)

• commit-parsing: Define limitation of revert commits with the scipy parser (5310d0c_)

• configuration: Change default value for allow_zero_version in the description (203d29d_)

• configuration: Change the default for the base changelog's mask_initial_release value
  (5fb02ab_)

• configuration: Change the default value for changelog.mode in the setting description
  (0bed906_)

• configuration: Update version_variables section to include double-equals operand support
  (PR#1244, 080e4bc)

• contributing: Refactor contributing & contributors layout (8bed5bc_)

• github-actions: Add reference to manual release workflow example (6aad7f1_)

• github-actions: Change recommended workflow to separate release from deploy (67b2ae0_)

• github-actions: Update python-semantic-release/publish-action parameter notes (c4d45ec_)

• github-actions: Update PSR action parameter documentation (a082896_)

• upgrading: Re-locate version upgrade guides into Upgrading PSR (a5f5e04_)

• upgrading-v10: Added migration guide for v9 to v10 (4ea92ec_)

⚙️ Build System

• deps: Prevent update to [email protected] (PR#1245, 4aa6a6e)

♻️ Refactoring

• config: Change allow_zero_version default to false (c6b6eab_)

• config: Change changelog.default_templates.mask_initial_release default to true
  (0e114c3_)

• config: Change changelog.mode default to update (7d39e76_)

💥 Breaking Changes

.. seealso::
For a summarized walkthrough, check out our |v10 migration guide|_ as well.

.. _v10 migration guide: ../upgrading/10-upgrade.html
.. |v10 migration guide| replace:: v10 migration guide

• changelog-md: The default Markdown changelog template and release notes template will no
  longer print out the entire commit message contents, instead, it will only print the commit
  subject line. This comes to meet the high demand of better formatted changelogs and requests for
  subject line only. Originally, it was a decision to not hide commit subjects that were included in
  the commit body via the git merge --squash command and PSR did not have another alternative.
  At this point, all the built-in parsers have the ability to parse squashed commits and separate
  them out into their own entry on the changelog. Therefore, the default template no longer needs to
  write out the full commit body. See the commit parser options if you want to enable/disable
  parsing squash commits.

• changelog-rst: The default ReStructured changelog template will no longer print out the entire
  commit message contents, instead, it will only print the commit subject line. This comes to meet
  the high demand of better formatted changelogs and requests for subject line only. Originally, it
  was a decision to not hide commit subjects that were included in the commit body via the git merge --squash command and PSR did not have another alternative. At this point, all the built-in
  parsers have the ability to parse squashed commits and separate them out into their own entry on
  the changelog. Therefore, the default template no longer needs to write out the full commit body.
  See the commit parser options if you want to enable/disable parsing squash commits.

• config: This release switches the allow_zero_version default to false. This change is
  to encourage less 0.x releases as the default but rather allow the experienced developer to
  choose when 0.x is appropriate. There are way too many projects in the ecosystems that never
  leave 0.x and that is problematic for the industry tools that help auto-update based on
  SemVer. We should strive for publishing usable tools and maintaining good forethought for when
  compatibility must break. If your configuration already sets the allow_zero_version value,
  this change will have no effect on your project. If you want to use 0.x versions, from the
  start then change allow_zero_version to true in your configuration.

• config: This release switches the changelog.default_templates.mask_initial_release default
  to true. This change is intended to toggle better recommended outputs of the default
  changelog. Conceptually, the very first release is hard to describe--one can only provide new
  features as nothing exists yet for the end user. No changelog should be written as there is no
  start point to compare the "changes" to. The recommendation instead is to only list a simple
  message as Initial Release. This is now the default for PSR when providing the very first
  release (no pre-existing tags) in the changelog and release notes. If your configuration already
  sets the changelog.default_templates.mask_initial_release value, then this change will have no
  effect on your project. If you do NOT want to mask the first release information, then set
  changelog.default_templates.mask_initial_release to false in your configuration.

• config: This release switches the changelog.mode default to update. In this mode, if a
  changelog exists, PSR will update the changelog IF AND ONLY IF the configured insertion flag
  exists in the changelog. The Changelog output will remain unchanged if no insertion flag exists.
  The insertion flag may be configured with the changelog.insertion_flag setting. When upgrading
  to v10, you must add the insertion flag manually or you can just delete the changelog file and
  run PSR's changelog generation and it will rebuild the changelog (similar to init mode) but it
  will add the insertion flag. If your configuration already sets the changelog.mode value, then
  this change will have no effect on your project. If you would rather the changelog be generated
  from scratch every release, than set the changelog.mode value to init in your
  configuration.

• github-action: The root_options action input parameter has been removed because it created
  a command injection vulnerability for arbitrary code to execute within the container context of
  the GitHub action if a command injection code was provided as part of the root_options
  parameter string. To eliminate the vulnerability, each relevant option that can be provided to
  semantic-release has been individually added as its own parameter and will be processed
  individually to prevent command injection. Please review our Github Actions Configuration__ page
  to review the newly available configuration options that replace the root_options parameter.

  __ https://github.com/python-semantic-release/python-semantic-release/blob/v10.0.0/docs/configuration/automatic-releases/github-actions.rst

• parser-conventional: Any breaking change footer messages that the conventional commit parser
  detects will now be removed from the commit.descriptions[] list but maintained in and only in
  the commit.breaking_descriptions[] list. Previously, the descriptions included all text from
  the commit message but that was redundant as the default changelog now handles breaking change
  footers in its own section.

• parser-conventional, parser-emoji, parser-scipy: Any issue resolution footers that the parser
  detects will now be removed from the commit.descriptions[] list. Previously, the descriptions
  included all text from the commit message but now that the parser pulls out the issue numbers the
  numbers will be included in the commit.linked_issues tuple for user extraction in any
  changelog generation.

• parser-conventional, parser-emoji, parser-scipy: Any release notice footer messages that the
  commit parser detects will now be removed from the commit.descriptions[] list but maintained
  in and only in the commit.notices[] list. Previously, the descriptions included all text from
  the commit message but that was redundant as the default changelog now handles release notice
  footers in its own section.

• parser-conventional, parser-emoji, parser-scipy: Generally, a pull request or merge request
  number reference is included in the subject line at the end within parentheses on some common
  VCS's like GitHub. PSR now looks for this reference and extracts it into the
  commit.linked_merge_request and the commit.linked_pull_request attributes of a commit
  object. Since this is now pulled out individually, it is cleaner to remove this from the first
  line of the commit.descriptions list (ie. the subject line) so that changelog macros do not
  have to replace the text but instead only append a PR/MR link to the end of the line. The
  reference does maintain the PR/MR prefix indicator (# or !).

• parser-conventional, parser-emoji, parser-scipy: The configuration setting
  commit_parser_options.ignore_merge_commits is now set to true by default. The feature to
  ignore squash commits was introduced in v9.18.0 and was originally set to false to
  prevent unexpected results on a non-breaking update. The ignore merge commits feature prevents
  additional unnecessary processing on a commit message that likely will not match a commit message
  syntax. Most merge commits are syntactically pre-defined by Git or Remote Version Control System
  (ex. GitHub, etc.) and do not follow a commit convention (nor should they). The larger issue with
  merge commits is that they ultimately are a full copy of all the changes that were previously
  created and committed. The merge commit itself ensures that the previous commit tree is
  maintained in history, therefore the commit message always exists. If merge commits are parsed,
  it generally creates duplicate messages that will end up in your changelog, which is less than
  desired in most cases. If you have previously used the changelog.exclude_commit_patterns
  functionality to ignore merge commit messages then you will want this setting set to true to
  improve parsing speed. You can also now remove the merge commit exclude pattern from the list as
  well to improve parsing speed. If this functionality is not desired, you will need to update your
  configuration to change the new setting to false.

• parser-conventional, parser-emoji, parser-scipy: The configuration setting
  commit_parser_options.parse_squash_commits is now set to true by default. The feature to
  parse squash commits was introduced in v9.17.0 and was originally set to false to prevent
  unexpected results on a non-breaking update. The parse squash commits feature attempts to find
  additional commits of the same commit type within the body of a single commit message. When
  squash commits are found, Python Semantic Release will separate out each commit into its own
  artificial commit object and parse them individually. This potentially can change the resulting
  version bump if a larger bump was detected within the squashed components. It also allows for the
  changelog and release notes to separately order and display each commit as originally written. If
  this is not desired, you will need to update your configuration to change the new setting to
  false.

.. _#733: #​733
.. _080e4bc: 080e4bc
.. _0bed906: 0bed906
.. _0e114c3: 0e114c3
.. _16465f1: 16465f1
.. _203d29d: 203d29d
.. _3cfee76: 3cfee76
.. _4aa6a6e: 4aa6a6e
.. _4e52f4b: 4e52f4b
.. _4ea92ec: 4ea92ec
.. _514a922: 514a922
.. _5310d0c: 5310d0c
.. _58308e3: 58308e3
.. _59bf084: 59bf084
.. _5fb02ab: 5fb02ab
.. _634fffe: 634fffe
.. _67b2ae0: 67b2ae0
.. _6aad7f1: 6aad7f1
.. _6cd0fbe: 6cd0fbe
.. _6fcdc99: 6fcdc99
.. _731466f: 731466f
.. _7d39e76: 7d39e76
.. _7e8dc13: 7e8dc13
.. _8a51525: 8a51525
.. _8bed5bc: 8bed5bc
.. _a082896: a082896
.. _a5f5e04: a5f5e04
.. _b1bb0e5: b1bb0e5
.. _b271cbb: b271cbb
.. _b6307cb: b6307cb
.. _b757603: b757603
.. _bd3e7bf: bd3e7bf
.. _c4d45ec: c4d45ec
.. _c6b6eab: c6b6eab
.. _d4f128e: d4f128e
.. _da4140f: da4140f
.. _e7ac155: e7ac155
.. _eed63fa: eed63fa
.. _fb3da27: fb3da27
.. _PR#1244: #​1244
.. _PR#1245: #​1245

.. _changelog-v9.21.1:

---

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.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.