-
Notifications
You must be signed in to change notification settings - Fork 256
feat(release-notes): add tag comparison link to release notes when supported #1107
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
codejedi365
merged 3 commits into
python-semantic-release:master
from
codejedi365:feat/add-comparison-link-to-release-notes
Nov 30, 2024
Merged
feat(release-notes): add tag comparison link to release notes when supported #1107
codejedi365
merged 3 commits into
python-semantic-release:master
from
codejedi365:feat/add-comparison-link-to-release-notes
Nov 30, 2024
Conversation
This file contains hidden or 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
cc5295f
to
fec68fb
Compare
fec68fb
to
15c9ace
Compare
1 task
This was referenced Jan 31, 2025
Closed
Closed
Closed
This was referenced Feb 11, 2025
This was referenced Feb 22, 2025
1 task
Closed
1 task
1 task
1 task
This was referenced May 25, 2025
Closed
This was referenced Jun 2, 2025
1 task
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.
Purpose
Rationale
Its a common item to add to the release notes is a comparison URL to the previous version that was released. This adds it to the default release notes template.
How did you test?
Updated the release notes template unit test which has more than one release tested. It also is tested through the changelog command with the
--post-to-release-tag
option and luckily it caught the edge case of when you are trying to use PSR to update the release notes of an earlier release and it happens to be the very first one.