Release/2.3.0 #77
Open
Release/2.3.0 #77
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
t-reents
approved these changes
Jul 30, 2024
There was a problem hiding this comment.
I know that this is a kind of standard function (also used in AiiDA-QE) that requires some manual adjustments, anyway. However, I realized that the title Changelog is simply overwritten and that the date is missing next to the new version. Therefore, I added some small suggestions to also respect these aspects in the generated template.
Comment on lines
+84
to
+86
| with Path('CHANGELOG.md').open('w', encoding='utf8') as handle: | ||
| handle.write(changelog_message + '\n\n' + current_changelog) | ||
|
|
There was a problem hiding this comment.
Suggested change
| with Path('CHANGELOG.md').open('w', encoding='utf8') as handle: | |
| handle.write(changelog_message + '\n\n' + current_changelog) | |
| changelog_header = '# Change log\n\n' | |
| with Path('CHANGELOG.md').open('w', encoding='utf8') as handle: | |
| handle.write(changelog_header + current_changelog.replace(changelog_header, changelog_message + '\n\n')) |
|
|
||
| changelog_message = f'## v{__version__}\n' + DEFAULT_CHANGELOG_SECTIONS | ||
|
|
||
| for commit in commits.splitlines(): |
There was a problem hiding this comment.
Suggested change
| for commit in commits.splitlines(): | |
| release_date = date.today() | |
| changelog_message = f'## `v{__version__}` - {release_date}\n' + DEFAULT_CHANGELOG_SECTIONS |
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.
No description provided.