Add Rake task to format changelog #1272
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
ericmustin
reviewed
Dec 7, 2020
| @@ -50,6 +50,7 @@ Gem::Specification.new do |spec| | |||
| spec.add_development_dependency 'minitest', '= 5.10.1' | |||
| spec.add_development_dependency 'minitest-around', '0.5.0' | |||
| spec.add_development_dependency 'minitest-stub_any_instance', '1.0.2' | |||
| spec.add_development_dependency 'pimpmychangelog', '>= 0.1.2' | |||
There was a problem hiding this comment.
do we want to pin to a specific minor version here since this isn't 1.0 yet?
ericmustin
approved these changes
Dec 7, 2020
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.
After our changelog was linkified in #1267, we should have mechanisms in place to ensure it stays that way.
This PR adds a Rake task that formats the changelog with the proper GitHub links:
rake changelog:format.There's also a new CI that verifies the the changelog was properly formatted prior to release. This jobs runs on release branches, which we name with the pattern
bump_to_version_.*. If we forget to format the changelog, we'll be reminded by in our version bump PR.