Generate human-readable ChangeLog #88
Closed
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
Only keep a single copy of the version string to avoid forgetting to update it in one place when we bump it.
In the Vox Pupuli tradition, use labels in GitHub issues to generate a human readable changelog when we release a new version of the code.
Some parts of CI run with a bundle without the packaging gems, we should not raise an error if the github_changelog_generator gem is not found, but rather tell how to fix that when the task is called.
rwaffen
approved these changes
Jun 1, 2025
smortex
reviewed
Jun 2, 2025
| config.project = "puppet" | ||
| config.exclude_labels = %w[dependencies duplicate question invalid wontfix wont-fix modulesync skip-changelog] | ||
| config.future_release = Puppet::PUPPETVERSION | ||
| config.since_tag = '7.36.1' |
Member
There was a problem hiding this comment.
If we require_relative 'lib/puppet/version', we can:
Suggested change
| config.since_tag = '7.36.1' | |
| config.since_tag = Puppet::PUPPETVERSION |
smortex
reviewed
Jun 3, 2025
| - Remove unused ContentsDescription class [\#44](https://github.com/OpenVoxProject/puppet/pull/44) ([ekohl](https://github.com/ekohl)) | ||
| - Fix a typo and some formatting in the type and provider docs [\#43](https://github.com/OpenVoxProject/puppet/pull/43) ([smoeding](https://github.com/smoeding)) | ||
| - Avoid closing directory we're iterating [\#42](https://github.com/OpenVoxProject/puppet/pull/42) ([ekohl](https://github.com/ekohl)) | ||
| - Set version to 8.16.0 [\#40](https://github.com/OpenVoxProject/puppet/pull/40) ([nmburgan](https://github.com/nmburgan)) |
Member
There was a problem hiding this comment.
This should not appear in the 7.x changelog ;-)
smortex
reviewed
Jun 3, 2025
| @@ -1,6 +1,8 @@ | |||
| require_relative 'lib/puppet/version' | |||
Member
There was a problem hiding this comment.
This happened to be a terrible idea as the file is copied in AIO packages while it is used to generate the final .gemspec file when installing from a gem and the path do not match.
Member
|
I succeeded in fixing the various issues I noted above in #93. Still not perfect due to bugs in GCG, but at least the information is consistent for PRs and does not inclue irrelevant issues. I will close this one in favor of it. Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
backported from #82