•

cmd-version: Fix error where --no-tag is not respected, closes #1304 (PR#1329, b090fa2)

• CHANGELOG: Update hyperlink in v10.4.0's additional info paragraph (PR#1323, 98ef722)
• getting-started-guide: Remove notice about lack of monorepo support, closes #1326 (PR#1327, 3f21f3f)
• github-actions: Fix recommended upstream detection script's upstream name parsing (PR#1328, ccc91c0)

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

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

•

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.

•

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

•

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

•

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

•

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.

•

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

•

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

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

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

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

•

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

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

•

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

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

•

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

•

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

•

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

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

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

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

•

deps: Prevent update to click@8.2.0 (PR#1245, 4aa6a6e)

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

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

•

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

•

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

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

•

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

•

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

• cmd-version: Enable stamping of tag formatted versions into files, closes #846 (PR#1190, 8906d8e)
• cmd-version: Extend version_variables to stamp versions with @ symbol separator, closes #1156 (PR#1185, 23f69b6)

• configuration: Add usage information for tag format version stamping (PR#1190, 8906d8e)
• configuration: Clarify version_variables config description & @ separator usage (PR#1185, 23f69b6)

•

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

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

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

•

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

•

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

•

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.

•

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

• 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, closes #223 (PR#1166, 834ce32)
• changelog-rst: Add additional release info section to default ReStructuredText template, closes #223 (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, closes #223 (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, closes #223 (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, closes #228 (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 functions (PR#1161, f853cf0)

• Refactor parsing compatibility function to support older custom parsers (PR#1165, cf340c5)
• changelog: Fix parsing compatibility w/ custom parsers, closes #1162 (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, closes #1162 (PR#1165, cf340c5)

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

• changelog: Add sort_numerically filter function to template environment (PR#1146, 7792388)
• changelog: Parse squashed commits individually (PR#1112, cf785ca)
• config: Extend support of remote urls aliased using git insteadOf configurations, closes #1150 (PR#1151, 4045037)
• parsers: Parse squashed commits individually (PR#1112, cf785ca)
• parser-angular: Apply PR/MR numbers to all parsed commits from a squash merge (PR#1112, cf785ca)
• parser-angular: Upgrade angular parser to parse squashed commits individually, closes #1085 (PR#1112, cf785ca)
• parser-emoji: Add functionality to interpret scopes from gitmoji commit messages (PR#1112, cf785ca)
• parser-emoji: Upgrade emoji parser to parse squashed commits individually (PR#1112, cf785ca)
• version: Parse squashed commits individually (PR#1112, cf785ca)

•

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

•

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

• changelog-templates: Add description for new sort_numerically filter function (PR#1146, 7792388)
• commit-parsing: Add description for squash commit evaluation option of default parsers (PR#1112, cf785ca)
• configuration: Update the commit_parser_options setting description (PR#1112, cf785ca)

•

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

•

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

•

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

• changelog: Fixes PSR release commit exclusions for customized commit messages (PR#1139, f9a2078)
• cmd-version: Fixes --print-tag result to match configured tag format (PR#1134, a990aa7)
• cmd-version: Fixes tag format on default version when force bump for initial release, closes #1137 (PR#1138, 007fd00)
• config-changelog: Validate changelog.exclude_commit_patterns on config load (PR#1139, f9a2078)

• commit-parsing: Add the new custom parser import spec description for direct path imports, closes #687 (PR#1135, 0418fd8)
• configuration: Adjust commit_parser option definition for direct path imports (PR#1135, 0418fd8)

• changelog: Ensures user rendered files are trimmed to end with a single newline (PR#1118, 6dfbbb0)
• cli: Add error message of how to gather full error output (PR#1116, ba85532)
• cmd-version: Enable maintenance prereleases (PR#864, b88108e)
• cmd-version: Fix handling of multiple prerelease token variants & git flow merges (PR#1120, 8784b9a)
• cmd-version: Fix version determination algorithm to capture commits across merged branches (PR#1120, 8784b9a)
• cmd-version: Forces tag timestamp to be same time as release commit (PR#1117, 7898b11)
• cmd-version: Handle multiple prerelease token variants properly, closes #789 (PR#1120, 8784b9a)
• config: Ensure default config loads on network mounted windows environments, closes #1123 (PR#1124, a64cbc9)
• version: Remove some excessive log msgs from debug to silly level (PR#1120, 8784b9a)
• version-bump: Increment based on current commit's history only, closes #861 (PR#864, b88108e)

•

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

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

• changelog-md: Add a breaking changes section to default Markdown template, closes #244 (PR#1110, 4fde30e)
• changelog-md: Alphabetize breaking change descriptions in markdown changelog template (PR#1110, 4fde30e)
• changelog-md: Alphabetize commit summaries & scopes in markdown changelog template (PR#1111, 8327068)
• changelog-rst: Add a breaking changes section to default reStructuredText template, closes #244 (PR#1110, 4fde30e)
• changelog-rst: Alphabetize breaking change descriptions in ReStructuredText template (PR#1110, 4fde30e)
• changelog-rst: Alphabetize commit summaries & scopes in ReStructuredText template (PR#1111, 8327068)
• commit-parser: Enable parsers to flag commit to be ignored for changelog, closes #778 (PR#1108, 0cc668c)
• default-changelog: Add a separate formatted breaking changes section, closes #244 (PR#1110, 4fde30e)
• default-changelog: Alphabetize commit summaries & scopes in change sections (PR#1111, 8327068)
• parsers: Add other_allowed_tags option for commit parser options (PR#1109, f90b8dc)
• parsers: Enable parsers to identify linked issues on a commit (PR#1109, f90b8dc)
• parser-angular: Automatically parse angular issue footers from commit messages (PR#1109, f90b8dc)
• parser-custom: Enable custom parsers to identify linked issues on a commit (PR#1109, f90b8dc)
• parser-emoji: Parse issue reference footers from commit messages (PR#1109, f90b8dc)
• release-notes: Add tag comparison link to release notes when supported (PR#1107, 9073344)

• cmd-version: Ensure release utilizes a timezone aware datetime (ca817ed)
• default-changelog: Alphabetically sort commit descriptions in version type sections (bdaaf5a)
• util: Prevent git footers from being collapsed during parse (PR#1109, f90b8dc)

• api-parsers: Add option documentation to parser options (PR#1109, f90b8dc)
• changelog-templates: Update examples using new commit.linked_issues attribute (PR#1109, f90b8dc)
• commit-parsing: Improve & expand commit parsing w/ parser descriptions (PR#1109, f90b8dc)

• changelog: Add md to rst conversion for markdown inline links (cb2af1f)
• changelog: Define first release w/o change descriptions for default MD template (fa89dec)
• changelog: Define first release w/o change descriptions for default RST template (e30c94b)
• changelog: Prefix scopes on commit descriptions in default template (PR#1093, 560fd2c)
• changelog-md: Add markdown inline link format macro (c6d8211)
• changelog-md: Prefix scopes on commit descriptions in Markdown changelog template (PR#1093, 560fd2c)
• changelog-rst: Prefix scopes on commit descriptions in ReStructuredText template (PR#1093, 560fd2c)
• configuration: Add changelog.default_templates.mask_initial_release option (595a70b)
• context: Add mask_initial_release setting to changelog context (6f2ee39)
• release-notes: Define first release w/o change descriptions in default template (83167a3)

•

release-notes: Override default word-wrap to non-wrap for in default template (99ab99b)

• changelog-templates: Document new mask_initial_release changelog context variable (f294957)
• configuration: Document new mask_initial_release option usage & effect (3cabcdc)
• homepage: Fix reference to new ci workflow for test status badge (6760069)

• changelog: Add PR/MR url linking to default Markdown changelog, closes #924, #953 (cd8d131)
• changelog: Add PR/MR url linking to default reStructuredText template, closes #924, #953 (5f018d6)
• parsed-commit: Add linked merge requests list to the ParsedCommit object (9a91062)
• parser-angular: Automatically parse PR/MR numbers from subject lines in commits (2ac798f)
• parser-emoji: Automatically parse PR/MR numbers from subject lines in commits (bca9909)
• parser-scipy: Automatically parse PR/MR numbers from subject lines in commits (2b3f738)

• changelog-rst: Ignore unknown parsed commit types in default RST changelog (77609b1)
• parser-angular: Drop the breaking category but still maintain a major level bump (f1ffa54)
• parsers: Improve reliability of descriptions after reverse word-wrap (436374b)

• parser-angular: Simplify commit parsing type pre-calculation (a86a28c)
• parser-emoji: Increase speed of commit parsing (2c9c468)
• parser-scipy: Increase speed & decrease complexity of commit parsing (2b661ed)

• changelog-templates: Add linked_merge_request field to examples (d4376bc)
• changelog-templates: Fix api class reference links (7a5bdf2)
• commit-parsing: Add linked_merge_request field to Parsed Commit definition (ca61889)

• bitbucket: Fix pull_request_url filter to ignore an PR prefix gracefully (PR#1089, 275ec88)
• cli: Gracefully capture all exceptions unless in very verbose debug mode (PR#1088, 13ca44f)
• gitea: Fix issue_url filter to ignore an issue prefix gracefully (PR#1089, 275ec88)
• gitea: Fix pull_request_url filter to ignore an PR prefix gracefully (PR#1089, 275ec88)
• github: Fix issue_url filter to ignore an issue prefix gracefully (PR#1089, 275ec88)
• github: Fix pull_request_url filter to ignore an PR prefix gracefully (PR#1089, 275ec88)
• gitlab: Fix issue_url filter to ignore an issue prefix gracefully (PR#1089, 275ec88)
• gitlab: Fix merge_request_url filter to ignore an PR prefix gracefully (PR#1089, 275ec88)
• hvcs: Add flexibility to issue & MR/PR url jinja filters (PR#1089, 275ec88)

•

changelog-templates: Update descriptions of issue & MR/PR url jinja filters (PR#1089, 275ec88)

• changelog: Fix raw-inline pattern replacement in convert_md_to_rst filter (2dc70a6)
• cmd-version: Fix --as-prerelease when no commit change from last full release (PR#1076, 3b7b772)
• release-notes: Add context variable shorthand ctx like docs claim & changelog has (d618d83)

•

contributing: Update local testing instructions (74f03d4)

•

changelog: Add autofit_text_width filter to template environment (PR#1062, 83e4b86)

• changelog: Ignore commit exclusion when a commit causes a version bump (e8f886e)
• parser-angular: Change Fixes commit type heading to Bug Fixes (PR#1064, 09e3a4d)
• parser-emoji: Enable the default bump level option (bc27995)

• changelog-templates: Add definition & usage of autofit_text_width template filter (PR#1062, 83e4b86)
• commit-parsers: Add deprecation message for the tag parser (af94540)
• configuration: Add deprecation message for the tag parser (a83b7e4)

•

changelog: Prevent custom template errors when components are in hidden folders (PR#1060, a7614b0)

• changelog: Add convert_md_to_rst filter to changelog environment (PR#1055, c2e8831)
• changelog: Add default changelog in re-structured text format, closes #399 (PR#1055, c2e8831)
• changelog: Add default changelog template in reStructuredText format (PR#1055, c2e8831)
• config: Enable default changelog.insertion_flag based on output format (PR#1055, c2e8831)
• config: Enable target changelog filename to trigger RST output format, closes #399 (PR#1055, c2e8831)

•

changelog: Correct spacing for default markdown template during updates (PR#1055, c2e8831)

• changelog: Clarify the convert_md_to_rst filter added to the template environment (PR#1055, c2e8831)
• changelog: Increase detail about configuration options of default changelog creation (PR#1055, c2e8831)
• configuration: Update changelog_file with deprecation notice of setting relocation (PR#1055, c2e8831)
• configuration: Update output_format description for reStructuredText support (PR#1055, c2e8831)
• configuration: Update details of insertion_flag's dynamic defaults with rst (PR#1055, c2e8831)

•

config: Handle branch match regex errors gracefully (PR#1054, 4d12251)

• changelog: Add changelog_insertion_flag to changelog template context (PR#1045, c18c245)
• changelog: Add changelog_mode to changelog template context (PR#1045, c18c245)
• changelog: Add prev_changelog_file to changelog template context (PR#1045, c18c245)
• changelog: Add read_file function to changelog template context (PR#1045, c18c245)
• changelog: Add shorthand ctx variable to changelog template env (PR#1045, c18c245)
• changelog: Modify changelog template to support changelog updates, closes #858 (PR#1045, c18c245)
• config: Add changelog.default_templates.output_format config option (PR#1045, c18c245)
• config: Add changelog.insertion_flag as configuration option (PR#1045, c18c245)
• config: Add changelog.mode as configuration option (PR#1045, c18c245)
• github-actions: Add an action build directive to toggle the --skip-build option (PR#1044, 26597e2)

• changelog: Adjust angular heading names for readability (PR#1045, c18c245)
• changelog: Ensure changelog templates can handle complex directory includes (PR#1045, c18c245)
• changelog: Only render user templates when files exist (PR#1045, c18c245)
• config: Prevent jinja from autoescaping markdown content by default (PR#1045, c18c245)

• changelog-templates: Improve detail & describe new changelog.mode="update" (PR#1045, c18c245)
• commands: Update definition of the version commands --skip-build option (PR#1044, 26597e2)
• configuration: Add changelog.mode and changelog.insertion_flag config definitions (PR#1045, c18c245)
• configuration: Define the new changelog.default_templates.output_format option (PR#1045, c18c245)
• configuration: Mark version of configuration setting introduction (PR#1045, c18c245)
• configuration: Standardize all true/false to lowercase ensuring toml-compatibility (PR#1045, c18c245)
• configuration: Update changelog.environment.autoescape default to false to match code (PR#1045, c18c245)
• github-actions: Add description of the build input directive (PR#1044, 26597e2)
• github-actions: Update primary example with workflow sha controlled pipeline (14f04df)
• homepage: Update custom changelog reference (PR#1045, c18c245)

•

github-actions: Add is_prerelease output to the version action (PR#1038, 6a5d35d)

• automatic-releases: Drop extraneous github push configuration (PR#1011, 2135c68)
• github-actions: Add configuration & description of publish action (PR#1011, 2135c68)
• github-actions: Add description of new is_prerelease output for version action (PR#1038, 6a5d35d)
• github-actions: Clarify & consolidate GitHub Actions usage docs, closes #907 (PR#1011, 2135c68)
• github-actions: Expand descriptions & clarity of actions configs (PR#1011, 2135c68)
• github-actions: Revert removal of namespace prefix from examples (PR#1011, 2135c68)
• homepage: Remove link to old github config & update token scope config (PR#1011, 2135c68)

• version-cmd: Ensure version_variables do not match partial variable names (PR#1028, 156915c)
• version-cmd: Improve version_variables flexibility w/ quotes (ie. json, yaml, etc) (PR#1028, 156915c)
• version-cmd: Increase version_variable flexibility with quotations (ie. json, yaml, etc), closes #601, #706, #962, #1026 (PR#1028, 156915c)

• Update docstrings to resolve sphinx failures, closes #1029 (PR#1030, d84efc7)
• configuration: Add clarity to version_variables usage & limitations (PR#1028, 156915c)
• homepage: Re-structure homepage to be separate from project readme (PR#1032, 2307ed2)
• README: Simplify README to point at official docs (PR#1032, 2307ed2)

•

config: Fix path traversal detection for windows compatibility, closes #994 (PR#1014, 16e6daa)

• configuration: Update build_command env table for windows to use all capital vars (0e8451c)
• github-actions: Update version in examples to latest version (3c894ea)

• Provide context.history global in release notes templates (PR#1005, 5bd91b4)
• release-notes: Fix noop-changelog to print raw release notes (PR#1005, 5bd91b4)
• release-notes: Provide context.history global in release note templates, closes #984 (PR#1005, 5bd91b4)

• Use pinned version for GHA examples (PR#1004, 5fdf761)
• changelog: Clarify description of the default changelog generation process (399fa65)
• configuration: Clarify changelog_file vs template_dir option usage, closes #983 (a7199c8)
• configuration: Fix build_command_env table rendering (PR#996, a5eff0b)
• github-actions: Adjust formatting & version warning in code snippets (PR#1004, 5fdf761)
• github-actions: Use pinned version for GHA examples, closes #1003 (PR#1004, 5fdf761)

•

version-cmd: Resolve build command execution in powershell (PR#980, 32c8e70)

•

configuration: Correct GHA parameter name for commit email (PR#981, ce9ffdb)

• Enable --print-last-released* when in detached head or non-release branch (PR#926, 782c0a6)
• changelog: Resolve commit ordering issue when dates are similar (PR#972, bfda159)
• version-cmd: Drop branch restriction for --print-last-released* opts, closes #900 (PR#926, 782c0a6)

• Improve git history processing for changelog generation (PR#972, bfda159)
• changelog: Improve git history parser changelog generation (PR#972, bfda159)

• changelog-cmd: Remove usage strings when error occurred, closes #810 (348a51d)
• changelog-cmd: Render default changelog when user template directory exist but is empty (bded8de)
• config: Prevent path traversal manipulation of target changelog location (43e35d0)
• config: Prevent path traversal manipulation of target changelog location (3eb3dba)
• publish-cmd: Prevent error when provided tag does not exist locally (16afbbb)
• publish-cmd: Remove usage strings when error occurred, closes #810 (afbb187)
• version-cmd: Remove usage strings when error occurred, closes #810 (a7c17c7)

•

parser: Strip DOS carriage-returns in commits, closes #955 (PR#956, 0b005df)

•

templates: Suppress extra newlines in default changelog (PR#954, 7b0079b)

• Improve build cmd env on windows (PR#942, d911fae)
• version-cmd: Pass windows specific env vars to build cmd when on windows (PR#942, d911fae)

•

configuration: Define windows specific env vars for build cmd (PR#942, d911fae)

• Extend gitlab to edit a previous release if exists (PR#934, 23e02b9)
• gha: Configure ssh signed tags in GitHub Action, closes #936 (PR#937, dfb76b9)
• hvcs-gitlab: Enable gitlab to edit a previous release if found (PR#934, 23e02b9)
• version-cmd: Add toggle of --no-verify option to git commit (PR#927, 1de6f78)

• gitlab: Adjust release name to mirror other hvcs release names (PR#934, 23e02b9)
• hvcs-gitlab: Add tag message to release creation (PR#934, 23e02b9)

• configuration: Add no_git_verify description to the configuration page (PR#927, 1de6f78)
• migration-v8: Update version references in migration instructions (PR#938, d6ba16a)

•

Enabled prerelease-token parameter in github action (PR#929, 1bb26b0)

• Enable user configuration of build_command env vars (PR#925, 6b5b271)
• version: Enable user config of build_command env variables, closes #922 (PR#925, 6b5b271)

• configuration: Clarify TOC & alphabetize configuration descriptions (19add16)
• configuration: Clarify TOC & standardize heading links (3a41995)
• configuration: Document build_command_env configuration option (PR#925, 6b5b271)
• CONTRIBUTING: Update build command definition for developers (PR#921, b573c4d)

•

gha: Fix missing git_committer_* definition in action, closes #918 (PR#919, ccef9d8)

•

version-cmd: Pass NEW_VERSION & useful env vars to build command (ee6b246)

• gha: Add missing tag option to GitHub Action definition, closes #906 (PR#908, 6b24288)
• gha: Correct use of prerelease option for GitHub Action (PR#914, 85e27b7)

• configuration: Add description of build command available env variables (c882dc6)
• gha: Update GitHub Actions doc with all available options (PR#914, 85e27b7)

•

deps: Bump GitHub Action container to use python3.12, closes #801 (PR#914, 85e27b7)

• Changelog filters are specialized per vcs type (PR#890, 76ed593)
• changelog: Changelog filters are hvcs focused (PR#890, 76ed593)
• changelog-context: Add flag to jinja env for which hvcs is available (PR#890, 76ed593)
• changelog-gitea: Add issue url filter to changelog context (PR#890, 76ed593)
• changelog-github: Add issue url filter to changelog context (PR#890, 76ed593)
• version-cmd: Add --as-prerelease option to force the next version to be a prerelease, closes #639 (PR#647, 2acb5ac)

• Correct version --prerelease use & enable --as-prerelease (PR#647, 2acb5ac)
• github: Correct changelog filter for pull request urls (PR#890, 76ed593)
• parser-custom: Gracefully handle custom parser import errors (67f6038)
• version-cmd: Correct --prerelease use, closes #639 (PR#647, 2acb5ac)

• changelog-context: Explain new hvcs specific context filters (PR#890, 76ed593)
• commands: Update version command options definition about prereleases (PR#647, 2acb5ac)

• Extend support to on-prem GitHub Enterprise Server (PR#896, 4fcb737)
• github: Extend support to on-prem GitHub Enterprise Server, closes #895 (PR#896, 4fcb737)

• bitbucket: Allow insecure http connections if configured (PR#886, db13438)
• bitbucket: Correct url parsing & prevent double url schemes (PR#676, 5cfdb24)
• config: Add flag to allow insecure connections (PR#886, db13438)
• gitea: Allow insecure http connections if configured (PR#886, db13438)
• gitea: Correct url parsing & prevent double url schemes (PR#676, 5cfdb24)
• github: Allow insecure http connections if configured (PR#886, db13438)
• github: Correct url parsing & prevent double url schemes (PR#676, 5cfdb24)
• gitlab: Allow insecure http connections if configured (PR#886, db13438)
• gitlab: Correct url parsing & prevent double url schemes (PR#676, 5cfdb24)
• hvcs: Allow insecure http connections if configured (PR#886, db13438)
• hvcs: Prevent double protocol scheme urls in changelogs (PR#676, 5cfdb24)
• version-cmd: Handle HTTP exceptions more gracefully (PR#886, db13438)

•

configuration: Update remote settings section with missing values, closes #868 (PR#886, db13438)

•

deps: Update rich requirement from ~=12.5 to ~=13.0, closes #888 (PR#877, 4a22a8c)

• gh-actions-output: Fixed trailing newline to match GITHUB_OUTPUT format (PR#885, 2c7b6ec)
• gh-actions-output: Fixed trailing newline to match GITHUB_OUTPUT format, closes #884 (PR#885, 2c7b6ec)

•

gitea: Derives gitea api domain from base domain when unspecified (PR#675, 2ee3f8a)

• algorithm: Handle merge-base errors gracefully, closes #724 (4c998b7)
• cli-version: Change implementation to only push the tag we generated, closes #803 (8a9da4f)

•

algorithm: Simplify logs & use lookup when searching for commit & tag match (3690b95)

• cmd-version: Changelog available to bundle (PR#779, 37fdb28)
• cmd-version: Create changelog prior to build enabling doc bundling (PR#779, 37fdb28)

•

cli: Enable subcommand help even if config is invalid, closes #840 (91d221a)

•

parse-git-url: Handle urls with url-safe special characters (27cd93a)

• version: Add new version print flags to display the last released version and tag (814240c)
• version-config: Add option to disable 0.x.x versions (dedb3b7)

• changelog: Make sure default templates render ending in 1 newline (0b4a45e)
• changelog-generation: Fix incorrect release timezone determination (f802446)

• configuration: Add description of allow-zero-version configuration option (4028f83)
• configuration: Clarify the major_on_zero configuration option (f7753cd)

•

deps: Add click-option-group for grouping exclusive flags (bd892b8)

•

parse_git_url: Fix bad url with dash (1c25b8e)

•

Add bitbucket hvcs (bbbbfeb)

•

Remove unofficial environment variables (a5168e4)

• Add bitbucket authentication (b78a387)
• Add bitbucket to token table (56f146d)
• Fix typo (b240e12)

•

deps: Bump minimum required tomlkit to >=0.11.0, closes #834 (291aace)

•

algorithm: Correct bfs to not abort on previously visited node (02df305)

•

algorithm: Refactor bfs search to use queue rather than recursion (8b742d3)

•

util: Properly parse windows line-endings in commit messages, closes #820 (70193ba)

•

Remove duplicate note in configuration.rst (PR#807, fb6f243)

•

config: Set commit parser opt defaults based on parser choice (PR#782, 9c594fb)

•

Drop support for Python 3.7 (PR#828, ad086f5)

• Removed Python 3.7 specific control flows and made more modern implementations the default control flow without a bypass or workaround. Will break on Python 3.7 now. If you require Python 3.7, you should lock your major version at v8. Since we only have enough manpower to maintain the latest major release, unfortunately there will not be any more updates to v8.
• We decided to remove support for Python 3.7 because it has been officially deprecated by the Python Foundation over a year ago and our codebase is starting to have limitations and custom implementations just to maintain support for 3.7.

•

lint: Correct linter errors (c9556b0)

•

cli-generate-config: Ensure configuration types are always toml parsable (PR#785, 758e649)

• Add note on default envvar behavior (PR#780, 0b07cae)
• configuration: Change defaults definition of token default to table (PR#786, df1df0d)
• contributing: Add docs-build, testing conf, & build instructions (PR#787, 011b072)

•

config: Enable default environment token per hvcs (PR#774, 26528eb)

•

utils: Expand parsable valid git remote url formats (PR#771, cf75f23)

•

Minor correction to commit-parsing documentation (PR#777, 245e878)

•

cli: Gracefully output configuration validation errors (PR#772, e8c9d51)

• cmd-version: Handle committing of git-ignored file gracefully (PR#764, ea89fa7)
• config: Cleanly handle repository in detached HEAD state (PR#765, ac4f9aa)
• config: Gracefully fail when repo is in a detached HEAD state (PR#765, ac4f9aa)
• version: Only commit non git-ignored files during version commit (PR#764, ea89fa7)

• configuration: Adjust wording and improve clarity (PR#766, 6b2fc8c)
• configuration: Fix typo in text (PR#766, 6b2fc8c)

•

Allow template directories to contain a '.' at the top-level (PR#762, 07b232a)

• cmd-version: Add --tag/--no-tag option to version command (PR#752, de6b9ad)
• version: Add --no-tag option to turn off tag creation (PR#752, de6b9ad)

•

version: Separate push tags from commit push when not committing changes (PR#752, de6b9ad)

• commands: Update version subcommand options (PR#752, de6b9ad)
• migration: Fix comments about publish command (PR#747, 90380d7)

•

action: Use composite action for semantic release (PR#692, 4648d87)

•

Allow user customization of release notes template (PR#736, 94a1311)

•

Add PYTHONPATH mention for commit parser (3284258)

• Correct lint errors (a13a6c3)
• Error when running build command on windows systems (PR#732, 2553657)

•

Attribute error when logging non-strings (PR#711, 75e6e48)

•

Upgrade pydantic to v2 (PR#714, 5a5c5d0)

• Fix typos (PR#708, 2698b0e)
• Update project urls (PR#715, 5fd5485)

•

Dynamic_import() import path split (PR#686, 1007a06)

•

Use correct upload url for github (PR#661, 8a515ca)

•

publish: Improve error message when no tags found (PR#683, bdc06ea)

•

Don't warn about vcs token if ignore_token_for_push is true. (PR#670, f1a54a6)

• password should be token. (PR#670, f1a54a6)
• Fix typo missing 's' in version_variable[s] in configuration.rst (PR#668, 879186a)

•

changelog: Use version as semver tag by default (PR#653, 5984c77)

• Add Python 3.11 to classifiers in metadata (PR#651, 5a32a24)
• Clarify usage of assets config option (PR#655, efa2b30)

•

Skip non-parsable versions when calculating next version (PR#649, 88f25ea)

•

Handle missing configuration (PR#644, f15753c)

• Better description for tag_format usage (2129b72)
• Clarify v8 breaking changes in GitHub action inputs (PR#643, cda050c)
• Correct version_toml example in migrating_from_v7.rst (PR#641, 325d5e0)

•

Invalid version in Git history should not cause a release failure (PR#632, 254430b)

• Reduce readthedocs formats and add entries to migration from v7 guide (9b6ddfe)
• migration: Fix hyperlink (PR#631, 5fbd52d)

• publish-cmd: Add --post-to-release-tag option to control where to publish (PR#619, ec30564)
• Make it easier to access commit messages in ParsedCommits (PR#619, ec30564)
• Remove publication of dists/ to artifact repository (PR#619, ec30564)
• Rename 'upload' configuration section to 'publish' (PR#619, ec30564)
• github-action: Add GitHub Actions output variables (PR#619, ec30564)
• version-cmd: Add --skip-build option (PR#619, ec30564)
• version-cmd Add --strict version mode (PR#619, ec30564)

• Add logging for token auth, use token for push (PR#619, ec30564)
• Caching for repo owner and name (PR#619, ec30564)
• Correct assets type in configuration (PR#619, ec30564)
• Correct assets type-annotation for RuntimeContext (PR#619, ec30564)
• Correct Dockerfile CLI command and GHA fetch (PR#619, ec30564)
• Correct handling of build commands (PR#619, ec30564)
• Correct logic for generating release notes (PR#619, ec30564)
• Create_or_update_release for Gitlab hvcs (PR#619, ec30564)
• Make additional attributes available for template authors (PR#619, ec30564)
• Only call Github Action output callback once defaults are set (PR#619, ec30564)
• Remove commit amending behavior (PR#619, ec30564)
• Resolve branch checkout logic in GHA (PR#619, ec30564)
• Resolve bug in changelog logic, enable upload to pypi (PR#619, ec30564)
• Resolve loss of tag_format configuration (PR#619, ec30564)
• github-action: Pin Debian version in Dockerfile (PR#619, ec30564)
• github-action: Correct input parsing (PR#619, ec30564)
• github-action: Mark container fs as safe for git to operate on (PR#619, ec30564)
• github-action: Quotation for git config command (PR#619, ec30564)
• github-action: Remove default for 'force' (PR#619, ec30564)

• Convert to Furo theme (PR#619, ec30564)
• Fix typo (PR#619, ec30564)
• Remove reference to dist publication (PR#619, ec30564)
• Update docs with additional required permissions (PR#619, ec30564)
• changelog-templates: fix typo (PR#619, ec30564)

•

Remove verify-ci command (PR#619, ec30564)

•

numerous breaking changes, see Upgrading to v8 for more information

•

Relax invoke dependency constraint (18ea200)

•

Consider empty commits (PR#608, 6f2e890)

•

Docker build fails installing git (PR#605, 9e3eb97)

•

Generate markdown linter compliant changelog headers & lists (PR#597, cc87400)

•

Open all files with explicit utf-8 encoding (PR#596, cb71f35)

•

Generate markdown linter compliant changelog headers & lists (PR#594, 9d9d403)

•

Add option to only parse commits for current working directory (PR#509, cdf8116)

• Update docs and default config for gitmoji changes (PR#590, 192da6e)
• Update sphinx dep (PR#590, 192da6e)

•

Update broken badge and add links (PR#591, 0c23447)

•

If prerelease, publish prerelease (PR#587, 927da9f)

• Trim emojis from config (PR#583, 02902f7)
• Update Gitmojis according to official node module (PR#582, 806fcfa)

• Grammar in docs/troubleshooting.rst (PR#557, bbe754a)
• Spelling and grammar in travis.rst (PR#556, 3a76e9d)
• Update repository name (PR#559, 5cdb05e)

•

Inconsistent versioning between print-version and publish (PR#524, 17d60e9)

•

action: Mark container fs as safe for git (PR#552, 2a55f68)

• Add signing options to action (31ad5eb)
• Update action with configuration options (PR#518, 4664afe)
• repository: Add support for TWINE_CERT, closes #521 (PR#522, d56e85d)

• Changelog release commit search logic (PR#530, efb3410)
• github-actions: Bump Dockerfile to use Python 3.10 image, closes #533 (PR#536, 8f2185d)
• action: Fix environment variable names (3c66218)

•

Update documentation (5cbdad2)

•

Fix changelog generation in tag-mode (PR#171, 482a62e)

•

Fix code blocks (PR#506, 24b7673)

•

Corrections for deprecation warnings (PR#505, d47afb6)

•

Correct spelling mistakes (PR#504, 3717e0d)

•

Add setting for enforcing textual changelog sections, closes #498 (PR#502, 988437d)

•

Correct documented default behavior for commit_version_number (PR#497, ffae2dc)

•

Account for trailing newlines in commit messages, closes #490 (PR#495, 111b151)

•

Use commit_subject when searching for release commits (PR#488, 3849ed9)

• Add better handling of missing changelog placeholder, closes #454 (e7a0e81)
• Add repo=None when not in git repo, closes #422 (40be804)

•

Add example for pyproject.toml (2a4b8af)

•

Update git email in action, closes #473 (0ece6f2)

• Add prerelease-patch and no-prerelease-patch flags for whether to auto-bump prereleases (b4e5b62)
• Override repository_url w REPOSITORY_URL env var (PR#439, cb7578c)

•

•

Declare additional_options as action inputs (PR#481, cb5d8c7)

•

Don't use commit_subject for tag pattern matching (PR#480, ac3f11e)

•

Add additional_options input for GitHub Action (PR#477, aea60e3)

•

Allow empty additional options (PR#479, c9b2514)

•

Ignore dependency version bumps when parsing version from commit logs (PR#476, 51bcb78)

•

Allow changing prerelease tag using CLI flags (PR#466, 395bf4f)

• Add packaging module requirement (PR#469, b99c9fa)
• publish: Get version bump for current release (PR#467, dd26888)

•

Add text for empty ValueError (PR#461, 733254a)

•

Ensure that assets can be uploaded successfully on custom GitHub servers (PR#458, 32b516d)

•

Ensure should_bump checks against release version if not prerelease (PR#457, da0606f)

•

Capture correct release version when patch has more than one digit (PR#448, 426cdc7)

• Allow using ssh-key to push version while using token to publish to hvcs (PR#419, 7b2dffa)
• config: Add ignore_token_for_push param (PR#419, 7b2dffa)

• Fix and refactor prerelease (PR#435, 94c9494)
• test: Override GITHUB_ACTOR env (PR#419, 7b2dffa)

•

Add documentation for ignore_token_for_push (PR#419, 7b2dffa)

•

Fix getting current version when version_source=tag_only (PR#437, b247936)

•

Add tag_only option for version_source, closes #354 (PR#436, cf74339)

•

prerelease: Pass prerelease option to get_current_version (PR#432, aabab0b)

•

Add git-lfs to docker container (PR#427, 184e365)

• publish-cmd: add --prerelease cli flag to enable prerelease versioning (PR#413, 7064265)
• version-cmd: add --prerelease cli flag to enable prerelease versioning (PR#413, 7064265)

•

Added basic info about prerelease versioning (PR#413, 7064265)

•

gitea: Use form-data from asset upload (PR#421, e011944)

• gitea: Build status and asset upload (PR#420, 57db81f)
• gitea: Handle list build status response (PR#420, 57db81f)

•

hvcs: Add gitea support (PR#412, b7e7936)

•

Document tag_commit, closes #410 (b631ca0)

•

Include additional changes in release commits (3e34f95)

•

Support Github Enterprise server (b4e01f1)

•

parser_angular: Allow customization in parser (298eebb)

•

Address PR feedback for parser_angular.py (f7bc458)

•

Use gitlab-ci or github actions env vars, closes #363 (8ca8dd4)

•

Remove invalid repository exception (746b62d)

• Allow custom environment variable names (PR#392, 372cda3)
• Rewrite Twine adapter for uploading to artifact repositories (cfb20af)

• Don't use linux commands on windows (PR#393, 5bcccd2)
• Mypy errors in vcs_helpers (13ca0fe)
• Skip removing the build folder if it doesn't exist (8e79fdc)

•

Clean typos and add section for repository upload (1efa18a)

•

Fixed ImproperConfig import error (PR#377, b011a95)

•

Add get_formatted_tag helper instead of hardcoded v-prefix in the git tags (1a354c8)

•

Custom git tag format support (PR#373, 1d76632)

• configuration: define tag_format usage & resulting effect (PR#373, 1d76632)
• parser: Documentation for scipy-parser (45ee34a)

•

Add support for non-prefixed tags (PR#366, 0fee4dd)

•

Clarify second argument of ParsedCommit (086ddc2)

•

parser: Add scipy style parser (PR#369, 51a3921)

•

Correct rendering of gitlab issue references, closes #358 (07429ec)

•

Print right info if token is not set, closes #360 (PR#361, a275a7a)

•

Use release-api for gitlab (1ef5cab)

• Recommend setting a concurrency group for GitHub Actions (34b0735)
• Update trove classifiers to reflect supported versions (PR#344, 7578004)

•

Tomlkit should stay at 0.7.0 (769a5f3)

•

Add option to omit tagging (PR#341, 20603e5)

•

Update click and tomlkit (PR#339, 947ea3b)

•

Pin tomlkit to 0.7.0 (2cd0db4)

•

Change log level of failed toml loading, closes #235 (24bb079)

•

Add venv to path in github action (583c5a1)

• Run semantic-release in virtualenv in the github action, closes #331 (b508ea9)
• Set correct path for venv in action script (aac02b5)
• Use absolute path for venv in github action (d4823b3)

•

Clarify that HVCS should be lowercase, closes #330 (da0ab0c)

• Add support for setting build_command to "false", closes #328 (520cf1e)
• Upgrade python-gitlab range, closes #329 (abfacc4)

•

Add common options to documentation, closes #327 (20d79a5)

•

Allow the use of .pypirc for twine uploads (PR#325, 6bc56b8)

•

Add documentation for releasing on a Jenkins instance (PR#324, 77ad988)

•

checks: Add support for Jenkins CI (PR#322, 3e99855)

• Correct casing on proper nouns (PR#320, d51b999)
• Correcting Python casing (PR#320, d51b999)
• Correcting Semantic Versioning casing (PR#320, d51b999)

• Crash when TOML has no PSR section (PR#319, 5f8ab99)
• Fix crash when TOML has no PSR section (PR#319, 5f8ab99)

•

Fix version_toml example for Poetry (PR#318, 39acb68)

•

Use multiline version_pattern match in replace, closes #306 (PR#315, 1a85af4)

•

Support toml files for version declaration, closes #245, #275 (PR#307, 9b62a7e)

•

github: Retry GitHub API requests on failure (PR#314, ac241ed)

•

github: Add retries to github API requests (PR#314, ac241ed)

•

actions: Pat must be passed to checkout step too, closes #311 (e2d8e47)

•

print-version: Add print-version command to output version (512e3d9)

• Add dot to --define option help (eb4107d)
• Avoid Unknown bump level 0 message (8ab624c)
• actions: Fix github actions with new main location (6666672)

•

Add __main__.py magic file (e93f36a)

•

build: Allow falsy values for build_command to disable build step (c07a440)

• Fix incorrect reference syntax (42027f0)
• Rewrite getting started page (97a9046)

•

hvcs: Add hvcs_domain config option, closes #277 (ab3061a)

• history: Coerce version to string (PR#298, d4cdc3d)
• history: Require semver >= 2.10 (5087e54)

•

repository: Add to settings artifact repository (f4ef373)

•

cli: Skip remove_dist where not needed (04817d4)

• Filenames with unknown mimetype are now properly uploaded to github release (f3ece78)
• logs: Fix TypeError when enabling debug logs (2591a94)

•

Add upload_to_pypi_glob_patterns option (42305ed)

• changelog: Use "issues" link vs "pull" (93e48c9)
• netrc: Prefer using token defined in GH_TOKEN instead of .netrc file (3af32a7)

•

changelog: Add PR links in markdown (PR#282, 0448f6c)

•

Add major_on_zero option (d324154)

•

Add documentation for option major_on_zero (2e8b26e)

•

logs: Include scope in changelogs (PR#281, 21c96b6)

•

Add "changelog_capitalize" to flags, closes #278 (PR#279, 37716df)

•

Add changelog_capitalize configuration, closes #260 (7cacca1)

• Fix broken internal references (PR#270, da20b9b)
• Update links to Github docs (PR#268, c53162e)

•

Generate changelog.md file (PR#266, 2587dfe)

•

Fix docstring (5a5e2cf)

•

Add required to inputs in action metadata (PR#264, e76b255)

•

Use range for toml dependency, closes #241 (45707e1)

•

Support multiline version_pattern matching by default (82f7849)

• Create 'getting started' instructions (PR#256, 5f4d000)
• Link to getting started guide in README (f490e01)

•

changelog: Send changelog to stdout, closes #250 (87e2bb8)

•

Add quotation marks to the pip commands in CONTRIBUTING.rst (PR#253, e20fa43)

•

Commit all files with bumped versions (PR#249, b3a1766)

•

Give example of multiple build commands (PR#248, 65f1ffc)

•

Bump versions in multiple files, closes #175 (PR#246, 0ba2c47)

•

changelog: Swap sha and message in table changelog (6741370)

•

changelog: Add changelog_table component, closes #237 (PR#242, fe6a7e7)

• Pass changelog_sections to components (PR#240, 3e17a98)
• changelog: Add changelog components (PR#240, 3e17a98)

• Add conda-forge badge (e9536bb)
• Add documentation for changelog_components (PR#240, 3e17a98)

•

changelog: The compare_url option has been removed in favor of using changelog_components. This functionality is now available as the semantic_release.changelog.compare_url component.

•

Convert \r\n to \n in commit messages, closes #239 (34acbbc)

•

history: Create emoji parser (PR#238, 2e1c50a)

• Add emojis to default changelog_sections (PR#238, 2e1c50a)
• Include all parsed types in changelog (PR#238, 2e1c50a)

•

Add documentation for emoji parser (PR#238, 2e1c50a)

•

history: Get breaking changes in parser (PR#238, 2e1c50a)

•

Use getboolean for commit_version_number, closes #186 (a60e0b4)

•

history: Support linking compare page in changelog, closes #218 (79a8e02)

• Document compare_link option (e52c355)
• Rewrite commit-log-parsing.rst (4c70f4f)

•

history: Check all paragraphs for breaking changes, closes #200 (fec08f0)

• Add = to verbosity option, closes #227 (a0f4c9c)
• Use references where possible, closes #221 (f38e5d4)

• actions: Support PYPI_TOKEN on GitHub Actions (df2c080)
• pypi: Support easier use of API tokens, closes #213 (bac135c)

•

Add documentation for PYPI_TOKEN (a8263a0)

•

hvcs: Convert get_hvcs to use LoggedFunction (3084249)

• Create Read the Docs config file (aa5a1b7)
• Include README.rst in index.rst (8673a9d)
• Move action.rst into main documentation (509ccaf)
• Rewrite README.rst (e049772)
• Rewrite troubleshooting page (0285de2)

•

debug: Use logging and click_log instead of ndebug (15b1f65)

•

debug: debug="*" no longer has an effect, instead use --verbosity DEBUG.

•

github: Add tag as default release name (2997908)

•

Automate API docs (7d4fea2)

•

history: Allow customizing changelog_sections (PR#207, d5803d5)

• Improve formatting of configuration page (9a8e22e)
• Improve formatting of envvars page (b376a56)
• Update index.rst (b27c26c)

• Bump dependencies and fix Windows issues on Development (PR#173, 0a6f8c3)
• Missing mime types on Windows (PR#173, 0a6f8c3)

•

history: Leave case of other characters unchanged (96ba94c)

•

Make action use current version of semantic-release (123984d)

•

build: Allow config setting for build command, closes #188 (PR#195, 740f4bd)

•

Rename default of build_command config (d5db22f)

•

pypi: Update docstrings in pypi.py (6502d44)

•

build: Previously the build_commands configuration variable set the types of bundles sent to python setup.py. It has been replaced by the configuration variable build_command which takes the full command e.g. python setup.py sdist or poetry build.

•

actions: Create GitHub Action (350245d)

• Make AUTHORS.rst dynamic (db2e076)
• readme: Fix minor typo (c22f69f)

•

Make commit message configurable (PR#184, eb0762c)

•

pypi: Add build_commands config (22146ea)

•

pypi: Change bdist_wheels to bdist_wheel (c4db509)

•

git: Add a new config for commit author (aa2c22c)

•

Repair parsing of remotes in the gitlab ci format, closes #181 (0fddbe2)

• Upload distribution files to GitHub Releases (PR#177, e427658)
• github: Upload dists to release (PR#177, e427658)

• Post changelog after PyPI upload (PR#177, e427658)
• Support repository owner names containing dots, closes #179 (a6c4da4)
• github: Fix upload of .whl files (PR#177, e427658)
• github: Use application/octet-stream for .whl files (90a7e47)

•

Document upload_to_release config option (PR#177, e427658)

•

history: Capitalize changelog messages (1a8e306)

• Add more debug statements in logs (bc931ec)
• Only overwrite with patch if bump is None, closes #159 (1daa4e2)

•

github: Send token in request header, closes #167 (be9972a)

• Add note about automatic releases in readme (e606e75)
• Fix broken list in readme (7aa572b)
• Update readme and getting started docs (07b3208)

•

history: Enable colon defined version, closes #165 (7837f50)

• Remove erroneous submodule (762bfda)
• cli: --noop flag works when before command, closes #73 (4fcc781)

•

Add quotes around twine arguments, closes #163 (46a83a9)

• parser: Add support for exclamation point for breaking changes, closes #156 (a4f8a10)
• parser: Make BREAKING-CHANGE synonymous with BREAKING CHANGE (beedccf)

•

github: Add check for GITHUB_ACTOR for git push (PR#162, c41e9bb)

•

Fallback to whole log if correct tag is not available, closes #51 (PR#157, 252bffd)

• Instead of requiring click 7.0, looks like all tests will pass with at least 2.0. (PR#155, f07c7f6)
• Set version of click to >=2.0,<8.0. (PR#155, f07c7f6)
• Upgrade to click 7.0, closes #117 (PR#155, f07c7f6)

•

Update regex to get repository owner and name for project with dots, closes #151 (2778e31)

•

Support repo urls without git terminator (700e9f1)

• Add the possibility to load configuration from pyproject.toml (35f8bfe)
• Allow the override of configuration options from cli, closes #119 (f0ac82f)
• Allow users to get version from tag and write/commit bump to file, closes #104 (1f9fe1c)
• Make the vcs functionalities work with gitlab, closes #121 (82d555d)

• Manage subgroups in git remote url, closes #139, #140 (4b11875)
• Update list of commit types to include build, ci and perf, closes #145 (41ea12f)

• Add configuration to customize handling of dists, closes #115 (2af6f41)
• Add support for configuring branch, closes #43 (14abb05)
• Add support for showing unreleased changelog, closes #134 (41ef794)

• Add commit hash when generating breaking changes, closes #120 (0c74faf)
• Kept setting new version for tag source (0e24a56)
• Remove deletion of build folder, closes #115 (b45703d)
• Updated the tag tests (3303eef)
• Upgrade click to 7.0 (2c5dd80)

• Correct isort build fail (0037210)
• Make sure the history only breaks loop for version commit, closes #135 (5dc6cfc)
• vcs: Allow cli to be run from subdirectory (fb7bb14)

•

circleci: Point badge to master branch (9c7302e)

• Correct usage of changelog (f4f59b0)
• Debug usage and related (f08e594)
• Describing the commands (b6fa04d)
• Update url for commit guidelinesThe guidelines can now be found in theDEVELOPERS.md in angular. (90c1b21)

•

ci_checks: Add support for bitbucket (9fc120d)

• Initialize git Repo from current folder (c7415e6)
• Maintain version variable formatting on bump (PR#103, bf63156)
• Use same changelog code for command as post (248f622)

• Add installation instructions for development (PR#106, 9168d0e)
• readme: Add testing instructions (bb352f5)

• Add better error message when pypi credentials are empty, closes #96 (c4e5dcb)
• Clean out dist and build before building, closes #86 (b628e46)
• Filter out pypi secrets from exceptions, closes #41 (5918371)
• Unfreeze dependencies, closes #100 (847833b)
• Use correct syntax to exclude tests in package, closes #92 (3e41e91)
• parser_angular: Fix non-match when special chars in scope (8a33123)

•

Remove reference to gitter, closes #90 (896e37b)

• Add support for commit_message config variable (4de5400)
• CI checks: Add support for GitLab CI checks, closes #88 (8df5e2b)

• Add check of credentials (7d945d4)
• Add credentials check (0694604)
• Add dists to twine call (1cec2df)
• Change requests from fixed version to version range (PR#93, af3ad59)
• Re-add skip-existing (366e9c1)
• Remove repository argument in twine (e24543b)
• Remove universal from setup config (18b2402)
• Update twine (c4ae7b8)
• Use new interface for twine (c04872d)
• Use twine through cli call (ab84beb)

• Add type hints and more complete docstrings, closes #81 (a6d5e9b)
• Fix typo in documentation index (da6844b)

•

Remove support for python 2 (85fe638)

• If you rely on the commit message to be the version number only, this will break your code
• This will only work with python 3 after this commit.

•

Upgrade twine (9722313)

•

Change Gitpython version number, closes #80 (23c9d4b)

•

Add retry option to cli docs (021da50)

• Add --retry cli option (PR#78, 3e312c0)
• Add support to finding previous version from tags if not using commit messages (PR#68, 6786487)
• Be a bit more forgiving to find previous tags (PR#68, 6786487)

• Add pytest cache to gitignore (b8efd5a)
• Make repo non if it is not a git repository, closes #74 (1dc306b)

• Define --retry usage (3e312c0)
• Remove old notes about trello board (7f50c52)
• Update status badges (cfa13b8)

•

Error when not in git repository, closes #74 (PR#75, 251b190)

•

Update call to upload to work with twine 1.9.1 (PR#72, 8f47643)

•

Update Twine (PR#69, 9f268c3)

•

Add git hash to the changelog (PR#65, 628170e)

•

Make changelog problems not fail whole publish (b5a68cf)

•

Fix typo in cli.py docstring (PR#64, 0d13985)

• Add option for choosing between versioning by commit or tag (c0cd1f5)
• Don't use file to track version, only tag to commit for versioning (cd25862)
• Get repo version from historical tags instead of config file (a45a9bf)

•

Can't get the proper last tag from commit history (5a0e681)

•

Add search_parent_directories option to gitpython (PR#62, 8bf9ce1)

•

Add ci checks for circle ci (151d849)

• Add git fetch to frigg after success (74a6cae)
• Make tag parser work correctly with breaking changes (9496f6a)
• Refactoring cli.py to improve --help and error messages (c79fc34)

• Add info about correct commit guidelines (af35413)
• Add info about trello board in readme (5229557)
• Fix badges in readme (7f4e549)
• Update info about releases in contributing.md (466f046)

•

Move code around a bit to make flake8 happy (41463b4)

•

configuration: Fix typo in setup.cfg section (725d87d)

•

Add ci_checks for Frigg CI (577c374)

•

Add requests as dependency (4525a70)

•

Add checks for semaphore, closes #44 (2d7ef15)

• Add documentation for configuring on CI (7806940)
• Add note about node semantic release (0d2866c)
• Add step by step guide for configuring travis ci (6f23414)
• Move automatic-releases to subfolder (ed68e5b)
• Remove duplicate readme (42a9421)

• Add author in commit, closes #40 (020efaa)
• Checkout master before publishing (dc4077a)

•

Remove " from git push command (031318b)

•

Convert readme to rst (e8a8d26)

•

Add travis environment checks (f386db7)

•

Do git push and git push --tags instead of --follow-tags (8bc70a1)

•

Change build badge (0dc068f)

•

Update docstrings for generate_changelog (987c6a9)

• Add pandoc to travis settings (17d40a7)
• Only list commits from the last version tag, closes #28 (191369e)

•

Add support for environment variables for pypi credentials (3b383b9)

• Add missing parameters to twine.upload (4bae22b)
• Better filtering of github token in push error (9b31da4)
• Downgrade twine to version 1.5.0 (66df378)
• Make sure the github token is not in the output (55356b7)
• Push to master by default (a0bb023)

• Add requirements to manifest (ed25ecb)
• pypi: Add sdist as default in addition to bdist_wheel (a1a35f4)

• angular-parser: Remove scope requirement (90c9d8d)
• git: Add push to GH_TOKEN@github-url (546b5bf)

•

deps: Use one file for requirements (4868543)

•

pypi: Add option to disable pypi upload (f5cd079)

•

parser: Add tag parser (a7f392f)

• errors: Add exposing of errors in package (3662d76)
• version: Parse file instead for version (005dba0)

•

github: Fix property calls (7ecdeb2)

•

hvcs: Make Github.token an property (37d5e31)

• api: Update apidocs (6185380)
• parsers: Add documentation about commit parsers (9b55422)
• readme: Update readme with information about the changelog command (56a745e)

•

cli: Fix call to generate_changelog in publish (5f8bce4)

•

history: Fix issue in get_previous_version (f961786)

•

cli: Add the possibility to re-post the changelog (4d028e2)

• cli: Fix check of token in changelog command (cc6e6ab)
• github: Fix the github releases integration (f0c3c1d)
• history: Fix changelog generation (f010272)

• cli: Add command for printing the changelog (336b8bc)
• github: Add github release changelog helper (da18795)
• history: Add angular parser (91e4f0f)
• history: Add generate_changelog function (347f21a)
• history: Add markdown changelog formatter (d77b58d)
• history: Set angular parser as the default (c2cf537)
• publish: Add publishing of changelog to github (74324ba)
• settings: Add loading of current parser (7bd0916)

• cli: Change output indentation on changelog (2ca41d3)
• history: Fix level id's in angular parser (2918d75)
• history: Fix regex in angular parser (974ccda)
• history: Support unexpected types in changelog generator (13deacf)

•

history: The default parser is now angular. Thus, the default behavior of the commit log evaluator will change. From now on it will use the angular commit message spec to determine the new version.

•

Restructure helpers into history and pypi (00f64e6)

•

Add automatic publishing documentation, resolves #18 (58076e6)

•

Fix get_current_head_hash to ensure it only returns the hash (7c28832)

•

Add Python 2.7 support, resolves #10 (c05e13f)

• Add check_build_status option, resolves #5 (310bb93)
• Add get_current_head_hash in git helpers (d864282)
• Add git helper to get owner and name of repo (f940b43)

•

Add patch_without_tag option, resolves #6 (3734a88)

•

Set up sphinx based documentation, resolves #1 (41fba78)

•

Add twine for uploads to pypi, resolves #13 (eec2561)

•

Add python2 not supported warning (e84c4d8)

•

Add wheel as a dependency (971e479)

•

Fix python wheel tag (f9ac163)

•

Fix push commands (8374ef6)

•

Add setup.py hook for the cli interface (c363bc5)

•

Add publish command (d8116c9)

•

No change

•

Fix wheel settings (1e860e8)

•

Add support for tagging releases (5f4736f)

•

Fix issue when version should not change (441798a)

•

added no-operation (--noop) mode (44c2039)

•

Swapped pygit2 with gitpython to avoid libgit2 dependency (8165a2e)

•

Fix entry point (bd7ce7f)

•

Initial Release

1.

Use SSH keys.

2.

Use an App Secret, store the secret in the BITBUCKET_TOKEN environment variable and the username in BITBUCKET_USER.

3.

Use an Access Token for the repository and store it in the BITBUCKET_TOKEN environment variable.

• ConventionalCommitParser
• ConventionalCommitMonorepoParser (available in v10.4.0+)
• AngularCommitParser (deprecated in v9.19.0)
• EmojiCommitParser
• ScipyCommitParser
• TagCommitParser (deprecated in v9.12.0)

• Version Bump Determination: This parser extracts the commit type from the subject line of the commit (the first line of a commit message). This type is matched against the configuration mapping to determine the level bump for the specific commit. If the commit type is not found in the configuration mapping, the commit is considered a non-parsable commit and will return it as a ParseError object and ultimately a commit of type "unknown". The configuration mapping contains lists of commit types that correspond to the level bump for each commit type. Some commit types are still valid do not trigger a level bump, such as "chore" or "docs". You can also configure the default level bump commit_parser_options.default_level_bump if desired. To trigger a major release, the commit message body must contain a paragraph that begins with BREAKING CHANGE:. This will override the level bump determined by the commit type.
• Changelog Generation: PSR will group commits in the changelog by the commit type used in the commit message. The commit type shorthand is converted to a more human-friendly section heading and then used as the version section title of the changelog and release notes. Under the section title, the parsed commit descriptions are listed out in full. If the commit includes an optional scope, then the scope is prefixed on to the first line of the commit description. If a commit has any breaking change prefixed paragraphs in the commit message body, those paragraphs are separated out into a "Breaking Changes" section in the changelog (Breaking Changes section is available from the default changelog in v9.15.0). Each breaking change paragraph is listed in a bulleted list format across the entire version. A single commit is allowed to have more than one breaking change prefixed paragraph (as opposed to the Conventional Commits Specification). Commits with an optional scope and a breaking change will have the scope prefixed on to the breaking change paragraph. Parsing errors will return a ParseError object and ultimately a commit of type "unknown". Unknown commits are consolidated into an "Unknown" section in the changelog by the default template. To remove unwanted commits from the changelog that normally are placed in the "unknown" section, consider the use of the configuration option changelog.exclude_commit_patterns to ignore those commit styles.
• Pull/Merge Request Identifier Detection: This parser implements PSR's Common Linked Merge Request Detection to identify and extract pull/merge request numbers. The parser will return a string value if a pull/merge request number is found in the commit message. If no pull/merge request number is found, the parser will return an empty string.
• Linked Issue Identifier Detection: This parser implements PSR's Common Issue Identifier Detection to identify and extract issue numbers. The parser will return a tuple of issue numbers as strings if any are found in the commit message. If no issue numbers are found, the parser will return an empty tuple.
• Squash Commit Evaluation: This parser implements PSR's Common Squash Commit Evaluation to identify and extract each commit message as a separate commit message within a single squashed commit. You can toggle this feature on/off via the commit_parser_options setting.
• Release Notice Footer Detection: This parser implements PSR's Common Release Notice Footer Detection, which is a custom extension to traditional Conventional Commits Specification to use the NOTICE keyword as a git footer to document additional release information that is not considered a breaking change.

•

Commits with the revert type are not currently supported. Track the implementation of this feature in the issue #402.

• Package Specific Commit Filtering: For monorepo support, this parser uses 2 filtering rules to determine if a commit should be considered for a specific package. The first rule is based on file paths that are changed in the commit and the second rule is based on the optional scope prefix defined in the commit message. If either rule matches, then the commit is considered relevant to that package and will be used in version determination, changelog generation, etc, for that package. If neither rule matches, then the commit is ignored for that package. File path filtering rules are applied first and are the primary way to determine package relevance. The path_filters option allows for specifying a list of file path patterns and will also support negated patterns to ignore specific paths that otherwise would be selected from the file glob pattern. Negated patterns are defined by prefixing the pattern with an exclamation point (!). File path filtering is quite effective by itself but to handle the edge cases, the parser has the scope_prefix configuration option to allow the developer to specifically define when the commit is relevant to the package. In monorepo setups, there are often shared files between packages (generally at the root project level) that are modified occasionally but not always relevant to the package being released. Since you do not want to define this path in the package configuration as it may not be relevant to the release, then this parser will look for a match with the scope prefix. The scope prefix is a regular expression that is used to match the text inside the scope field of a Conventional Commit. The scope prefix is optional and is used only if file path filtering does not match. Commits that have matching files in the commit will be considered relevant to the package regardless if a scope prefix exists or if it matches.
• Version Bump Determination: Once package-specific commit filtering is applied, the relevant commits are passed to the Conventional Commits Parser for evaluation and then used for version bump determination. See Conventional Commits Parser for details.
• Changelog Generation: Once package-specific commit filtering is applied, the relevant commits are passed to the Conventional Commits Parser for evaluation and then used for changelog generation. See Conventional Commits Parser for details.
• Pull/Merge Request Identifier Detection: Once package-specific commit filtering is applied, the relevant commits are passed to the Conventional Commits Parser for pull/merge request identifier detection. See Common Linked Merge Request Detection for details.
• Linked Issue Identifier Detection: Once package-specific commit filtering is applied, the relevant commits are passed to the Conventional Commits Parser for linked issue identifier detection. See Common Issue Identifier Detection for details.
• Squash Commit Evaluation: Squashed commits are separated out into individual commits with the same set of changed files BEFORE the package-specific commit filtering is applied. Each pseudo-commit is then subjected to the same filtering rules as regular commits. See Common Squash Commit Evaluation for details.
• Release Notice Footer Detection: Once package-specific commit filtering is applied, the relevant commits are passed to the Conventional Commits Parser for release notice footer detection. See Common Release Notice Footer Detection for details.

•

revert commit type is NOT supported, see Conventional Commits Parser's limitations for details.

• Version Bump Determination: This parser extracts the commit type from the subject line of the commit (the first line of a commit message). This type is matched against the configuration mapping to determine the level bump for the specific commit. If the commit type is not found in the configuration mapping, the commit is considered a non-parsable commit and will return it as a ParseError object and ultimately a commit of type "unknown". The configuration mapping contains lists of commit types that correspond to the level bump for each commit type. Some commit types are still valid do not trigger a level bump, such as "chore" or "docs". You can also configure the default level bump commit_parser_options.default_level_bump if desired. To trigger a major release, the commit message body must contain a paragraph that begins with BREAKING CHANGE:. This will override the level bump determined by the commit type.
• Changelog Generation: PSR will group commits in the changelog by the commit type used in the commit message. The commit type shorthand is converted to a more human-friendly section heading and then used as the version section title of the changelog and release notes. Under the section title, the parsed commit descriptions are listed out in full. If the commit includes an optional scope, then the scope is prefixed on to the first line of the commit description. If a commit has any breaking change prefixed paragraphs in the commit message body, those paragraphs are separated out into a "Breaking Changes" section in the changelog (Breaking Changes section is available from the default changelog in v9.15.0). Each breaking change paragraph is listed in a bulleted list format across the entire version. A single commit is allowed to have more than one breaking change prefixed paragraph (as opposed to the Angular Commit Style Guidelines). Commits with an optional scope and a breaking change will have the scope prefixed on to the breaking change paragraph. Parsing errors will return a ParseError object and ultimately a commit of type "unknown". Unknown commits are consolidated into an "Unknown" section in the changelog by the default template. To remove unwanted commits from the changelog that normally are placed in the "unknown" section, consider the use of the configuration option changelog.exclude_commit_patterns to ignore those commit styles.
• Pull/Merge Request Identifier Detection: This parser implements PSR's Common Linked Merge Request Detection to identify and extract pull/merge request numbers. The parser will return a string value if a pull/merge request number is found in the commit message. If no pull/merge request number is found, the parser will return an empty string. Feature available in v9.13.0+.
• Linked Issue Identifier Detection: This parser implements PSR's Common Issue Identifier Detection to identify and extract issue numbers. The parser will return a tuple of issue numbers as strings if any are found in the commit message. If no issue numbers are found, the parser will return an empty tuple. Feature available in v9.15.0+.
• Squash Commit Evaluation: This parser implements PSR's Common Squash Commit Evaluation to identify and extract each commit message as a separate commit message within a single squashed commit. You can toggle this feature on/off via the commit_parser_options setting. Feature available in v9.17.0+.
• Release Notice Footer Detection: This parser implements PSR's Common Release Notice Footer Detection, which is a custom extension to traditional Angular Commit Style Guidelines to use the NOTICE keyword as a git footer to document additional release information that is not considered a breaking change. Feature available in v9.18.0+.

•

Commits with the revert type are not currently supported. Track the implementation of this feature in the issue #402.

• Version Bump Determination: This parser only looks for emojis in the subject line of the commit (the first line of a commit message). If more than one emoji is found, the emoji configured with the highest priority is selected for the change impact for the specific commit. The emoji with the highest priority is the one configured in the major configuration option, followed by the minor, and patch in descending priority order. If no emoji is found in the subject line, the commit is classified as other and will default to the level bump defined by the configuration option commit_parser_options.default_level_bump.
• Changelog Generation: PSR will group commits in the changelog by the emoji type used in the commit message. The emoji is used as the version section title and the commit descriptions are listed under that section. No emojis are removed from the commit message so each will be listed in the changelog and release notes. When more than one emoji is found in the subject line of a commit, the emoji with the highest priority is the one that will influence the grouping of the commit in the changelog. Commits containing no emojis or non-configured emojis are consolidated into an "Other" section. To remove unwanted commits from the changelog that would normally be added into the "other" section, consider the use of the configuration option changelog.exclude_commit_patterns to ignore those commit styles.
• Pull/Merge Request Identifier Detection: This parser implements PSR's Common Linked Merge Request Detection to identify and extract pull/merge request numbers. The parser will return a string value if a pull/merge request number is found in the commit message. If no pull/merge request number is found, the parser will return an empty string. Feature available in v9.13.0+.
• Linked Issue Identifier Detection: [Disabled by default] This parser implements PSR's Common Issue Identifier Detection to identify and extract issue numbers. The parser will return a tuple of issue numbers as strings if any are found in the commit message. If no issue numbers are found, the parser will return an empty tuple. This feature is disabled by default since it is not a part of the Gitmoji Specification but can be enabled by setting the configuration option commit_parser_options.parse_linked_issues to true. Feature available in v9.15.0+.
• Squash Commit Evaluation: This parser implements PSR's Common Squash Commit Evaluation to identify and extract each commit message as a separate commit message within a single squashed commit. You can toggle this feature on/off via the commit_parser_options setting. Feature available in v9.17.0+.
• Release Notice Footer Detection: This parser implements PSR's Common Release Notice Footer Detection, which is a custom extension that uses the NOTICE keyword as a git footer to document additional release information that is not considered a breaking change. Feature available in v9.18.0+.

•

Commits with the REV type are not currently supported. Track the implementation of this feature in the issue #402.

1.

BitBucket: Merged in feat/my-awesome-feature (pull request #123)

2.

GitHub: feat: add new feature (#123)

3.

GitLab: fix: resolve an issue (!123)

• close (closes, closing, closed)
• fix (fixes, fixing, fixed)
• resolve (resolves, resolving, resolved)
• implement (implements, implementing, implemented)

• comma-separated (ex. Closes: #123, #456, #789)
• space-separated (ex. resolve: #123 #456 #789)
• semicolon-separated (ex. Fixes: #123; #456; #789)
• slash-separated (ex. close: #123/#456/#789)
• ampersand-separated (ex. Implement: #123 & #789)
• and-separated (ex. Resolve: #123 and #456 and #789)
• mixed (ex. Closed: #123, #456, and #789 or Fixes: #123, #456 & #789)

• BitBucket: Resolving Issues Automatically
• GitHub: Linking Issue to PR
• GitLab: Default Closing Patterns

1.

File Path & Class: The format is "path/to/module_file.py:ClassName". This is the easiest way to provide a custom parser. This method allows you to store your custom parser directly in the repository with no additional installation steps. PSR will locate the file, load the module, and instantiate the class. Relative paths are recommended and it should be provided relative to the current working directory. This import variant is available in v9.16.0 and later.

2.

Module Path & Class: The format is "package.module_name:ClassName". This method allows you to store your custom parser in a package that is installed in the same environment as PSR. This method is useful if you want to share your custom parser across multiple repositories. To share it across multiple repositories generally you will need to publish the parser as its own separate package and then pip install it into the current virtual environment. You can also keep it in the same repository as your project as long as it is in the current directory of the virtual environment and is locatable by the Python import system. You may need to set the PYTHONPATH environment variable if you have a more complex directory structure. This import variant is available in v8.0.0 and later.

To test that your custom parser is importable, you can run the following command in the directory where PSR will be executed:

python -c "from package.module_name import ClassName"

NOTE:

• MyParsedCommit subclasses ParsedCommit
• MyParseError subclasses ParseError
• MyParseResult = ParseResultType[MyParsedCommit, MyParseError]

• A class-level attribute parser_options, which must be set to ParserOptions or a subclass of this.
• An __init__ method which takes a single parameter, options, that should be of the same type as the class' parser_options attribute.
• A method, parse, which takes a single parameter commit that is of type git.objects.commit.Commit, and returns ParseResult, or a subclass of this.