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

Consider adding a default entry for empty changelog release entries in monorepos #71

Open
rekmarks opened this issue Aug 6, 2021 · 5 comments
Labels
enhancement New feature or request

Comments

@rekmarks
Copy link
Member

rekmarks commented Aug 6, 2021

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.

@rekmarks rekmarks added the enhancement New feature or request label Aug 6, 2021
@Gudahtt
Copy link
Member

Gudahtt commented Aug 10, 2021

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.

@rekmarks
Copy link
Member Author

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)

@Gudahtt
Copy link
Member

Gudahtt commented Aug 10, 2021

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.

@rekmarks
Copy link
Member Author

Hm, well for major version bumps, we could certainly do what you've done here: https://github.com/MetaMask/eslint-config/pull/212/files

@Gudahtt
Copy link
Member

Gudahtt commented Sep 24, 2021

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).

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

No branches or pull requests

2 participants