v9.20.0

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

v9.19.1

v9.19.1 (2025-02-11)

This release is published under the MIT License.

🪲 Bug Fixes

• changelog: Standardize heading format for across all version sections (PR#1182, 81f9e80)

• changelog-md: Standardize heading format for extra release information (PR#1182, 81f9e80)

• changelog-rst: Standardize heading format for extra release information (PR#1182, 81f9e80)

• config: Handle invalid commit_parser type gracefully (PR#1180, 903c8ba)

• release-notes: Standardize heading format for extra release information (PR#1182, 81f9e80)

📖 Documentation

• Fix spelling errors & inaccurate descriptions (55d4a05)

• automatic-releases: Declutter the table of contents for automatic release guides (e8343ee)

• commit-parsing: Update reference to section name of additional release info (PR#1182, 81f9e80)

---

Detailed Changes: v9.19.0...v9.19.1

---

Installable artifacts are available from:

• PyPi Registry

• GitHub Release Assets

v9.19.0

v9.19.0 (2025-02-10)

This release is published under the MIT License.

✨ Features

• parser-conventional: Add official conventional-commits parser (PR#1177, 27ddf84)

📖 Documentation

• Update references to Angular parser to Conventional Commit Parser (PR#1177, 27ddf84)

💡Additional Release Information

• parser-conventional: The 'angular' commit parser has been renamed to 'conventional' to match
  the official conventional-commits standard for which the 'angular' parser has evolved into. Please
  update your configurations to specify 'conventional' as the 'commit_parser' value in place of
  'angular'. The 'angular' type will be removed in v11.

---

Detailed Changes: v9.18.1...v9.19.0

---

Installable artifacts are available from:

• PyPi Registry

• GitHub Release Assets

v9.18.1

v9.18.1 (2025-02-08)

This release is published under the MIT License.

🪲 Bug Fixes

• config: Refactors default token resolution to prevent pre-mature insecure URL error (PR#1173, 37db258)

✅ Resolved Issues

• #1074: An error occurred in the workflow

• #1169: Commands are failing for self hosted gitea release hosted via http

---

Detailed Changes: v9.18.0...v9.18.1

---

Installable artifacts are available from:

• PyPi Registry

• GitHub Release Assets

v9.18.0

v9.18.0 (2025-02-06)

This release is published under the MIT License.

✨ Features

• Add create_release_url & format_w_official_vcs_name filters (PR#1161, f853cf0)

• changelog: Add create_pypi_url filter to jinja template render context (PR#1160, 45d49c3)

• changelog: Add additional release info to changeling from commit NOTICE's (PR#1166, 834ce32)

• changelog-md: Add additional release info section to default markdown template (PR#1166, 834ce32)

• changelog-rst: Add additional release info section to default ReStructuredText template (PR#1166, 834ce32)

• commit-parser: Enable parsers to identify additional release notices from commit msgs (PR#1166, 834ce32)

• parser-angular: Add a ignore_merge_commits option to discard parsing merge commits (PR#1164, 463e43b)

• parser-angular: Add functionality to parse out NOTICE: prefixed statements in commits (PR#1166, 834ce32)

• parser-emoji: Add a ignore_merge_commits option to discard parsing merge commits (PR#1164, 463e43b)

• parser-emoji: Add functionality to parse out NOTICE: prefixed statements in commits (PR#1166, 834ce32)

• parsers: Add option ignore_merge_commits to discard parsing merge commits (PR#1164, 463e43b)

• release-notes: Add license information to default release notes template (PR#1167, 41172c1)

• vcs-bitbucket: Add format_w_official_vcs_name filter function (PR#1161, f853cf0)

• vcs-gitea: Add create_release_url & format_w_official_vcs_name filter functions (PR#1161, f853cf0)

• vcs-github: Add create_release_url & format_w_official_vcs_name filter functions (PR#1161, f853cf0)

• vcs-gitlab: Add create_release_url & format_w_official_vcs_name filter functiions (PR#1161, f853cf0)

🪲 Bug Fixes

• Refactor parsing compatibility function to support older custom parsers (PR#1165, cf340c5)

• changelog: Fix parsing compatibility w/ custom parsers (PR#1165, cf340c5)

• changelog-templates: Adjust default templates to avoid empty version sections (PR#1164, 463e43b)

• parser-angular: Adjust parser to prevent empty message extractions (PR#1166, 834ce32)

• parser-emoji: Adjust parser to prevent empty message extractions (PR#1166, 834ce32)

• version: Fix parsing compatibility w/ custom parsers (PR#1165, cf340c5)

📖 Documentation

• changelog: Add formatted changelog into hosted documentation (PR#1155, 2f18a6d)

• changelog-templates: Add description for new create_pypi_url filter function (PR#1160, 45d49c3)

• changelog-templates: Add details about license specification in the release notes (PR#1167, 41172c1)

• changelog-templates: Define create_release_url & format_w_official_vcs_name filters (PR#1161, f853cf0)

• changelog-templates: Document special separate sections of commit descriptions (ebb4c67)

• commit-parsing: Document new release notice footer detection feature of built-in parsers (cd14e92)

✅ Resolved Issues

• #223: Add extra details to release from commit message

• #228: Add option to add license name to release

• #1162: Failure to determine correct level bump with custom parser in 9.17.0

---

Detailed Changes: v9.17.0...v9.18.0

---

Installable artifacts are available from:

• PyPi Registry

• GitHub Release Assets

v9.17.0

v9.17.0 (2025-01-26)

Features

• changelog: Add sort_numerically filter function to template environment (#1146, 7792388)

• changelog: Parse squashed commits individually (#1112, cf785ca)

• config: Extend support of remote urls aliased using git insteadOf configurations (#1151, 4045037)

• parsers: Parse squashed commits individually (#1112, cf785ca)

• parser-angular: Apply PR/MR numbers to all parsed commits from a squash merge (#1112, cf785ca)

• parser-angular: Upgrade angular parser to parse squashed commits individually (#1112, cf785ca)

• parser-emoji: Add functionality to interpret scopes from gitmoji commit messages (#1112, cf785ca)

• parser-emoji: Upgrade emoji parser to parse squashed commits individually (#1112, cf785ca)

• version: Parse squashed commits individually (#1112, cf785ca)

Bug Fixes

• github-action: Disable writing python bytecode in action execution (#1152, 315ae21)

Performance Improvements

• logging: Remove irrelevant debug logging statements (#1147, f1ef4ec)

Documentation

• changelog-templates: Add description for new sort_numerically filter function (#1146, 7792388)

• commit-parsing: Add description for squash commit evaluation option of default parsers (#1112, cf785ca)

• configuration: Update the commit_parser_options setting description (#1112, cf785ca)

Resolved Issues

• #1085: Commit Parser: Add support for squash commits (BitBucket Specific)

• #1150: Request support of git insteadOf url aliases

---

Detailed Changes: v9.16.1...v9.17.0

---

Installable artifacts are available from:

• PyPi Registry
• GitHub Release Assets

v9.16.1

v9.16.1 (2025-01-12)

Bug Fixes

• parser-custom: Handle relative parent directory paths to module file better (#1142, c4056fc)

Documentation

• github-actions: Update PSR versions in github workflow examples (#1140, 9bdd626)

---

Detailed Changes: v9.16.0...v9.16.1

---

Installable artifacts are available from:

• PyPi Registry
• GitHub Release Assets

v9.16.0

v9.16.0 (2025-01-12)

Features

• config: Expand dynamic parser import to handle a filepath to module (#1135, 0418fd8)

Bug Fixes

• changelog: Fixes PSR release commit exclusions for customized commit messages (#1139, f9a2078)

• cmd-version: Fixes --print-tag result to match configured tag format (#1134, a990aa7)

• cmd-version: Fixes tag format on default version when force bump for initial release (#1138, 007fd00)

• config-changelog: Validates changelog.exclude_commit_patterns on config load (#1139, f9a2078)

Documentation

• commit-parsing: Add the new custom parser import spec description for direct path imports (#1135, 0418fd8)

• configuration: Adjust commit_parser option definition for direct path imports (#1135, 0418fd8)

Resolved Issues

• #687: Fix: custom commit parser path loading
• #1137: Configured tag_format is ignored if there are no tags in the repository

---

Detailed Changes: v9.15.2...v9.16.0

---

Installable artifacts are available from:

• PyPi Registry
• GitHub Release Assets

v9.15.2

v9.15.2 (2024-12-16)

Bug Fixes

• changelog: Ensures user rendered files are trimmed to end with a single newline (#1118, 6dfbbb0)

• cli: Add error message of how to gather full error output (#1116, ba85532)

• cmd-version: Enable maintenance prereleases (#864, b88108e)

• cmd-version: Fix handling of multiple prerelease token variants & git flow merges (#1120, 8784b9a)

• cmd-version: Fix version determination algorithm to capture commits across merged branches (#1120, 8784b9a)

• cmd-version: Forces tag timestamp to be same time as release commit (#1117, 7898b11)

• cmd-version: Handle multiple prerelease token variants properly (#1120, 8784b9a)

• config: Ensure default config loads on network mounted windows environments (#1124, a64cbc9)

• version: Remove some excessive log msgs from debug to silly level (#1120, 8784b9a)

• version-bump: Increment based on current commit's history only (#864, b88108e)

Performance Improvements

• cmd-version: Refactor version determination algorithm for accuracy & speed (#1120, 8784b9a)

Resolved Issues

• #789: Fix: Version determination of 4 branch GitFlow repo
• #861: Releasing a prerelease patch of a maintenance version
• #1123: Default configuration fails with changelog error on windows with network mounted directory path

---

Detailed Changes: v9.15.1...v9.15.2

v9.15.1

v9.15.1 (2024-12-03)

Bug Fixes

• changelog-md: Fix commit sort of breaking descriptions section (75b342e)

• parser-angular: Ensure issues are sorted by numeric value rather than text sorted (3858add)

• parser-emoji: Ensure issues are sorted by numeric value rather than text sorted (7b8d2d9)

---

Detailed Changes: v9.15.0...v9.15.1