Keep more of GitHub release notes body #327
Merged
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
Only omit the first paragraph, "What's Changed." Keep the e.g. "New Contributors" paragraph.
|
FYI @ekcorso |
john-kurkowski
commented
Mar 19, 2024
| @@ -131,25 +124,15 @@ def get_changelog_release_notes(release_notes_url: str, version: str) -> str: | |||
| if match: | |||
| return str(match.group(1)).strip() | |||
| else: | |||
| print( | |||
| f"WARNING: Failed to parse changelog release notes. Manually copy this version's notes from the CHANGELOG.md file to {release_notes_url}.", | |||
There was a problem hiding this comment.
Haven't tripped on this error handler yet, but I think the URL in it was wrong. It's a compare link like 5.1.1...5.1.2, not a create-release link. I moved this error print to after we have the release link.
There was a problem hiding this comment.
Yeah, good point. I think I garbled this warning when I added the release_notes_url. Your new placement is correct: it should be directing the user to the url of the newly created draft release to manually add the notes. Thanks for catching this!
ekcorso
reviewed
Mar 21, 2024
| return "" | ||
| body = str(response.json()["body"]) | ||
| paragraphs = body.split("\n\n") | ||
| return "\n\n".join(paragraphs[1:]) |
There was a problem hiding this comment.
So concise and it got rid of the REGEX-- love it. Still a little brittle if this format changes, but I think this is a great improvement.
ekcorso
approved these changes
Mar 21, 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.
Only omit the first paragraph, "What's Changed." Keep the e.g. "New Contributors" paragraph and "Full Changelog" link.