Add CHANGELOG.md warning for missing releases, link to Github page #697
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
As CHANGELOG.md does not contain all major releases and breaking changes, the text "All notable changes to this project will be documented in this file" has been removed (as it is not accurate) and a warning has been added to check Github releases.
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/gregberge/svgr/hH7fjdmYb1t3GY6vaowF3QAMAGFy |
bradenneufeld
changed the title
|
Thanks @bradenneufeld |
This was referenced Oct 22, 2022
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.
Summary
As CHANGELOG.md does not contain all major releases and breaking changes (ie. it is missing 6.0.0), the text "All notable changes to this project will be documented in this file" has been causing confusion - it has been removed (as it is not accurate) and a warning has been added to check Github releases.
Test plan
No functional code changes.