Drop the changelog and point changelog_uri at the releases page - #23
Merged
Merged
Conversation
The release workflow already runs gh release create --generate-notes, so a hand written changelog duplicates it and adds a step to every release that is easy to forget. Until there are breaking changes worth writing migration notes for, the generated release notes are enough.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Reverts the
CHANGELOG.mdadded in #21.release.ymlalready runsgh release create --generate-notes, so GitHub builds release notes from the merged pull requests on every release. A hand written changelog duplicates that, and adds a step to each release that is easy to forget — a changelog nobody updates is worse than none.changelog_urinow points at the releases page, so the Changelog link on RubyGems.org keeps working and needs no maintenance.A curated changelog earns its keep once there are breaking changes worth writing migration notes for. That is a 1.0 concern; this gem is at 0.2.0 with 279 downloads on its latest version.
The gemspec was the only reference to the file.
Touches
emoja.gemspec, which #22 also touches. A trial merge of the two branches is clean, but merging #22 first keeps the order simple.