Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changelog is missing 6.0.0. #682

Closed
bradenneufeld opened this issue Feb 16, 2022 · 4 comments
Closed

Changelog is missing 6.0.0. #682

bradenneufeld opened this issue Feb 16, 2022 · 4 comments

Comments

@bradenneufeld
Copy link
Contributor

🐛 Bug Report

CHANGELOG.md skips from 5.5.0 to 6.1.0, failing to capture the breaking changes and instructions for migration.

image

To Reproduce

View https://github.com/gregberge/svgr/blob/main/CHANGELOG.md

Expected behavior

Changelog should include release notes for 6.0.0

@fatso83
Copy link

fatso83 commented Feb 21, 2022

Yeah, trying the default instructions failed with Webpack 4, so I was trying to find what was breaking in the Changelog (and failed). Had to try npm i @svgr/webpack@5 to get something working with Storybook (and even then it seems to fail to export the ReactComponent).

EDIT: Would be nice to document this in the breaking changes of the changelog, for instance 😃

@gregberge
Copy link
Owner

@bradenneufeld
Copy link
Contributor Author

bradenneufeld commented Mar 8, 2022

@gregberge I do see the notes on the tag on Github, but those are not present in CHANGELOG.md and therefore won't be seen when the repo is pulled/updated. If the CHANGELOG.md on this repo is not intended to be a full list of changes and the sole source of truth is actually the releases/tags on Github, it would be better to delete CHANGELOG.md entirely so that it's not misleading. Right now there's no indication on it that it does not include notes on some major releases or breaking changes but it does contain others, so it's easy to get confused like @fatso83 was - if it were gone then users would at least be prompted to look elsewhere for the real notes.

@bradenneufeld
Copy link
Contributor Author

Suggested warning PR opened here: #697

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants