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

CHANGELOGs are fustrating #13415

Closed
tomByrer opened this issue Apr 17, 2019 · 2 comments
Closed

CHANGELOGs are fustrating #13415

tomByrer opened this issue Apr 17, 2019 · 2 comments

Comments

@tomByrer
Copy link
Contributor

tomByrer commented Apr 17, 2019

https://github.com/gatsbyjs/gatsby/blob/ef6f84ccae0f48cf1c9334b50ed58fe145647ba6/packages/gatsby-transformer-sqip/CHANGELOG.md

Change Log...
2.0.31 (2019-04-17)

Note: Version bump only for package gatsby-transformer-sqip
2.0.30 (2019-04-11)

Note: Version bump only for package gatsby-transformer-sqip
2.0.29 (2019-04-09)

Note: Version bump only for package gatsby-transformer-sqip
2.0.28 (2019-03-27)

Note: Version bump only for package gatsby-transformer-sqip
2.0.27 (2019-03-25)

Note: Version bump only for package gatsby-transformer-sqip
2.0.26 (2019-03-20)

Note: Version bump only for package gatsby-transformer-sqip
2.0.25 (2019-03-15)

Note: Version bump only for package gatsby-transformer-sqip
2.0.24 (2019-03-12)

Note: Version bump only for package gatsby-transformer-sqip
2.0.23 (2019-03-11)

Note: Version bump only for package gatsby-transformer-sqip
2.0.22 (2019-03-11)

Note: Version bump only for package gatsby-transformer-sqip
2.0.21 (2019-03-05)

Note: Version bump only for package gatsby-transformer-sqip
2.0.20 (2019-03-04)

Note: Version bump only for package gatsby-transformer-sqip
2.0.19 (2019-02-28)

Note: Version bump only for package gatsby-transformer-sqip
2.0.18 (2019-02-22)

Note: Version bump only for package gatsby-transformer-sqip
2.0.17 (2019-02-19)

Note: Version bump only for package gatsby-transformer-sqip
2.0.16 (2019-02-01)

Note: Version bump only for package gatsby-transformer-sqip
2.0.15 (2019-01-29)

Note: Version bump only for package gatsby-transformer-sqip
2.0.14 (2019-01-25)

Note: Version bump only for package gatsby-transformer-sqip

2.0.13 (2019-01-23)

Note: Version bump only for package gatsby-transformer-sqip

2.0.12 (2018-12-27)

Note: Version bump only for package gatsby-transformer-sqip

2.0.11 (2018-12-21)

Note: Version bump only for package gatsby-transformer-sqip

2.0.10 (2018-12-07)

Note: Version bump only for package gatsby-transformer-sqip

2.0.9 (2018-11-29)

Note: Version bump only for package gatsby-transformer-sqip

2.0.8 (2018-11-21)

Note: Version bump only for package gatsby-transformer-sqip

2.0.7 (2018-11-06)

Note: Version bump only for package gatsby-transformer-sqip

2.0.6 (2018-11-01)

Note: Version bump only for package gatsby-transformer-sqip

2.0.5 (2018-10-29)

Note: Version bump only for package gatsby-transformer-sqip

2.0.4 (2018-10-29)

Note: Version bump only for package gatsby-transformer-sqip

2.0.3 (2018-10-24)

Note: Version bump only for package gatsby-transformer-sqip

2.0.2 (2018-10-16)

Note: Version bump only for package gatsby-transformer-sqip

2.0.1 (2018-10-03)

Note: Version bump only for package gatsby-transformer-sqip

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

@DSchau
Copy link
Contributor

DSchau commented Apr 17, 2019

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.

Quite a length of text that says nothing

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.

@DSchau DSchau closed this as completed Apr 17, 2019
@tomByrer
Copy link
Contributor Author

I understand the automated / Lerna thing. So couldn't the automation also do this?

2.0.1 - 2.0.31
No significant changes in package gatsby-transformer-sqip; version bumps only.

I would prefer the master CHANGELOG have all the substantive changes, or find them in the releases page.

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

2 participants