build: account for Python Semantic Release updates #483
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Well, it happened again. Python Semantic Release (PSR) released a minor version this week and it ended up having breaking changes. The irony is too much and at this point all releases are examined carefully for any breaking changes. This time, the v9.10.0 release of PSR included this commit, which changed the long names of the types of angular commits as they are referred to in a parsed release element: python-semantic-release/python-semantic-release@0766184 The effect would have been that, going forward, only commits with the `documentation` type would have been picked up for inclusion. The updates were accounted for in `templates/.changes.j2`. The other big change, but not breaking, for the v9.10.0 release, was the return of the placeholder style CHANGELOG insertion method. The mechanics behind it have changed since the pre-v8 releases, but the end result is the same. Since this method was and still is preferred, changes were made to take advantage of it. Those changes followed the guidance here: https://python-semantic-release.readthedocs.io/en/stable/changelog_templates.html#incrementally-updating-changelog-template The changes in this PR were tested locally and confirmed to work for the current configuration.
Phylum OSS Supply Chain Risk Analysis - SUCCESSThe Phylum risk analysis is complete and has passed the active policy. |
kylewillmon
approved these changes
Oct 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Well, it happened again. Python Semantic Release (PSR) released a minor version this week and it ended up having breaking changes. The irony is too much and at this point all releases are examined carefully for any breaking changes. This time, the v9.10.0 release of PSR included this commit, which changed the long names of the types of angular commits as they are referred to in a parsed release element:
python-semantic-release/python-semantic-release@0766184
The effect would have been that, going forward, only commits with the
documentationtype would have been picked up for inclusion. The updates were accounted for intemplates/.changes.j2.The other big change, but not breaking, for the v9.10.0 release, was the return of the placeholder style CHANGELOG insertion method. The mechanics behind it have changed since the pre-v8 releases, but the end result is the same. Since this method was and still is preferred, changes were made to take advantage of it. Those changes followed the guidance here:
https://python-semantic-release.readthedocs.io/en/stable/changelog_templates.html#incrementally-updating-changelog-template
The changes in this PR were tested locally and confirmed to work for the current configuration.