Add rake tasks to merge and create Changelog entries #131
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.
Fixes rubocop/rubocop#8697
After yet another Changelog merge issue, I decided to write some code to avoid it.
This PR adds a rake task to merge entries in
CHANGELOG/
according to the prefix of their path: "new" (feature), (bug) "fix" or "change". It merges those with any existing entries in the unreleased section of the Changelog, so it can be done at any moment, is backward compatible, and nobody is forced to use it (except before cutting a release, and I've added a check for that 😅).Other rake task
cl:new
,cl:fix
,cl:change
create an entry file (default use the last commit's message & git config).For a contributor, the workflow looks like this:
git commit
(enter a good commit message, optionally starting with[Fixes #xxx]
)bundle exec rake cl:fix
git commit --amend
@bbatsov any objection that I use this in
rubocop-ast
? May I adapt it forrubocop
too?