-
Notifications
You must be signed in to change notification settings - Fork 10.3k
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
CHANGELOGs are fustrating #13415
Comments
Hello Tom! Let's go through this! For some initial context, we use lerna and conventional-changelog messages to have those commits/info be shown on the individual plugins. This is an automated process that saves us quite a bit of time from manually curating CHANGELOG.md for each package.
Sort of agreed. Unfortunately, this is sort of expected for this particular case because we actually haven't made any substantive changes/fixes/or added new features. Specifically, if you look at the plugin's history you can see that mostly it's just been version bumps and other chore type tasks that aren't meaningful changes to document in a changelog. For a consumer of the plugin, there won't necessarily be a substantive change between 2.0.25 and for example, 2.0.31. We could make the root-level CHANGELOG.md link to each individual package, but I generally find the message there helpful to inform the user where to go for additional info. Do you disagree? So - generally, I see your point, but in this particular case, I don't think there is anything necessarily actionable on this front unless you have any ideas! Going to close this as answered--but would love a PR for this if we can improve on this front. |
I understand the automated / Lerna thing. So couldn't the automation also do this?
I would prefer the master CHANGELOG have all the substantive changes, or find them in the releases page. |
https://github.com/gatsbyjs/gatsby/blob/ef6f84ccae0f48cf1c9334b50ed58fe145647ba6/packages/gatsby-transformer-sqip/CHANGELOG.md
Quite a length of text that says nothing. However, there have been changes in this sub-repo not listed in the CHANGELOG.
& having to go into each sub-repo to find changes is frustrating.
I'd prefer if there was a master CHANGELOG with helpful info & without noise, or changes listed in the releases
The text was updated successfully, but these errors were encountered: