v10.3.1 (2025-08-06)

This release is published under the MIT License.

🪲 Bug Fixes

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

📖 Documentation

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

✅ Resolved Issues

• #1303: Improve GitHub Actions Docs

• #1307: v10.3.0 doesn't support a stage-then-release approach in GitHub Actions

Detailed Changes: v10.3.0...v10.3.1

Installable artifacts are available from:

• PyPi Registry

• GitHub Release Assets

2025-08-05 WARNING: GitHub Action broke if Action is run in a non-release mode (e.g. --no-commit, or --noop), see #1307 - Resolved in v10.3.1

v10.3.0 (2025-08-04)

This release is published under the MIT License.

✨ Features

• github-actions: Add commit_sha as a GitHub Actions output value (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 (PR#1287, f25883f)

📖 Documentation

• getting-started: Fixes changelog.exclude_commit_patterns example in startup guide (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)

✅ Resolved Issues

• #512: Add some additional GitHub Actions outputs

• #717: Add commit hash output to GitHub Action

• #1251: Bug: No-op mode fails to log any bracket-encased text in commit_message

• #1291: Typo in Getting Started Guide's exclude_commit_patterns example

Detailed Changes: v10.2.0...v10.3.0

Installable artifacts are available from:

• PyPi Registry

• GitHub Release Assets

v10.2.0 (2025-06-29)

This release is published under the MIT License.

✨ 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)

✅ Resolved Issues

• #1280: UV integration documentation examples do not work as intended

Detailed Changes: v10.1.0...v10.2.0

Installable artifacts are available from:

• PyPi Registry

• GitHub Release Assets

v10.1.0 (2025-06-12)

This release is published under the MIT License.

✨ Features

• cmd-version: Always stage version stamped files & changelog even with --no-commit (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)

✅ Resolved Issues

• #1211: Version files left unstaged for commit in 2 stage PSR execution

Detailed Changes: v10.0.2...v10.1.0

Installable artifacts are available from:

• PyPi Registry

• GitHub Release Assets

v10.0.2 (2025-05-26)

This release is published under the MIT License.

🪲 Bug Fixes

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

Detailed Changes: v10.0.1...v10.0.2

Installable artifacts are available from:

• PyPi Registry

• GitHub Release Assets

v10.0.1 (2025-05-25)

This release is published under the MIT License.

🪲 Bug Fixes

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

✅ Resolved Issues

• #1257: bug: github action v10.0.0 is still running PSR v9.21.1

Detailed Changes: v10.0.0...v10.0.1

Installable artifacts are available from:

• PyPi Registry

• GitHub Release Assets

v10.0.0 (2025-05-25)

This release is published under the MIT License.

✨ 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 (e7ac155)

• changelog-rst: Change to 1-line descriptions in the default ReStructuredText template (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 click@8.2.0 (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

For a summarized walkthrough, check out our v10 migration guide as well.

• 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 alternati...

v9.21.1 (2025-05-05)

This release is published under the MIT License.

🪲 Bug Fixes

• changelog-filters: Fixes url resolution when prefix & path share letters (PR#1239, f61f8a3)

📖 Documentation

• github-actions: Expound on monorepo example to include publishing actions (PR#1229, 550e85f)

⚙️ Build System

• deps: Bump rich dependency from 13.0 to 14.0 (PR#1224, 691536e)

• deps: Expand python-gitlab dependency to include v5.0.0 (PR#1228, a0cd1be)

✅ Resolved Issues

• #1204: Unexpected & Invalid urls generated in changelog

Detailed Changes: v9.21.0...v9.21.1

Installable artifacts are available from:

• PyPi Registry

• GitHub Release Assets

v9.21.0 (2025-02-23)

This release is published under the MIT License.

✨ Features

• Add package name variant, python-semantic-release, project script (PR#1199, 1ac97bc)

📖 Documentation

• github-actions: Update example workflow to handle rapid merges (PR#1200, 1a4116a)

✅ Resolved Issues

• #1195: Native uvx support

Detailed Changes: v9.20.0...v9.21.0

Installable artifacts are available from:

• PyPi Registry

• GitHub Release Assets

v9.20.0 (2025-02-17)

This release is published under the MIT License.

✨ Features

• cmd-version: Enable stamping of tag formatted versions into files (PR#1190, 8906d8e)

• cmd-version: Extend version_variables to stamp versions with @ symbol separator (PR#1185, 23f69b6)

📖 Documentation

• configuration: Add usage information for tag format version stamping (PR#1190, 8906d8e)

• configuration: Clarify version_variables config description & @ separator usage (PR#1185, 23f69b6)

⚙️ Build System

• deps: Add deprecated~=1.2 for deprecation notices & sphinx documentation (PR#1190, 8906d8e)

✅ Resolved Issues

• #846: Updating version_variables that follow tag_format

• #1156: Add @ to allowed separators of version_variables

Detailed Changes: v9.19.1...v9.20.0

Installable artifacts are available from:

• PyPi Registry

• GitHub Release Assets