Archive CHANGELOG.md #399
Merged
Archive CHANGELOG.md #399
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
When preparing a new release of the module, GCG overrite the whole CHANGELOG.md file, but it used to be crafted by hand and we do not want to loose this information. GCG can append an existing file to the generated changelog, and if this file is properly formatted, can guess which versions are covered by this HISTORY file to not include them again. Move the CHANGELOG.md to HISTORY.md and adjust the release lines so that GCG can properly parse the first one and the following ones are formatted the same way. The resulting CHANGELOG.md which will be generated on the next release preparation will be consistently formatted.
bastelfreak
approved these changes
Apr 15, 2024
kenyon
approved these changes
Apr 16, 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.
When preparing a new release of the module, GCG overrite the whole
CHANGELOG.md file, but it used to be crafted by hand and we do not want
to loose this information.
GCG can append an existing file to the generated changelog, and if this
file is properly formatted, can guess which versions are covered by this
HISTORY file to not include them again.
Move the CHANGELOG.md to HISTORY.md and adjust the release lines so that
GCG can properly parse the first one and the following ones are
formatted the same way. The resulting CHANGELOG.md which will be
generated on the next release preparation will be consistently
formatted.