-
-
Notifications
You must be signed in to change notification settings - Fork 18
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
Consider adding a default entry for empty changelog release entries in monorepos #71
Comments
It would be somewhat complicated to determine whether there was a real breaking change or not, since peer dependency changes might sometimes be breaking and other times not. I'm not sure we should attempt automating this - we might be better off just manually writing a note explaining whether it's breaking or not, and why. |
I think we're talking past each other. I'm not trying to automate anything that isn't already automated, I'm suggesting that we add a default change entry in cases where there were no changes whatsoever. Currently, the entire release entry is empty when that happens. Motivated by your comment here: MetaMask/eslint-config#198 (comment) |
Yes, I realize that. What I mean is that there is no one default entry that would be appropriate for all situations. Minimally a changelog entry for a major release should explain why it was breaking (if it was), and I'm not sure we can determine that automatically. So any default message would be insufficient. |
Hm, well for major version bumps, we could certainly do what you've done here: https://github.com/MetaMask/eslint-config/pull/212/files |
Not necessarily. There might have been other breaking changes aside from the peer dependency change. Also there might not be a peer dependency change (e.g. what if one of the "leaf" packages was the one that had the breaking change). |
Currently, if a monorepo package is released during a major version bump but hasn't changed, the changelog is by default empty. We should consider adding some kind of default so as to not confuse readers.
The text was updated successfully, but these errors were encountered: