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

Incorrect version in CHANGELOG.md for @wordpress/data #15030

Closed
nerrad opened this issue Apr 18, 2019 · 5 comments
Closed

Incorrect version in CHANGELOG.md for @wordpress/data #15030

nerrad opened this issue Apr 18, 2019 · 5 comments
Labels
[Package] Data /packages/data [Type] Bug An existing feature does not function as intended

Comments

@nerrad
Copy link
Contributor

nerrad commented Apr 18, 2019

Describe the bug
The @wordpress/data package.json has 4.4.0 (the released version on npm), but the highest version in the CHANGELOG.md file is 4.3.0. Not sure how this should be resolved yet, might need a review of when/where things were published and see where the versions went awry for the changelog.

@nerrad nerrad added [Type] Bug An existing feature does not function as intended [Package] Data /packages/data labels Apr 18, 2019
@nerrad nerrad added this to the 5.6 (Gutenberg) milestone Apr 18, 2019
@youknowriad
Copy link
Contributor

That's not specific to WordPress data, we don't update the CHANGELOG files if there's no "unreleased" entry in the files.

I guess this should be closed once we land #13594

@nerrad
Copy link
Contributor Author

nerrad commented Apr 18, 2019

That's not specific to WordPress data, we don't update the CHANGELOG files if there's no "unreleased" entry in the files.

Can you clarify this a bit more please? Are saying that a package might get a version bump even if there's no changes in that package? Or are you saying there is a case here where someone has forgot to add changes to the CHANGELOG.md and thus it didn't have an Unreleased section, and thus a version didn't get added?

I'm guessing by your reference to #13594 you mean the latter. If so, then should the CHANGELOG.md get updated to have the missing changes for 2.4.0?

If you mean the former, then I wonder if we should add a disclaimer/note to the top of all changelogs that regardless of version of the package, there will only be entries where there are actual changes?

@youknowriad
Copy link
Contributor

youknowriad commented Apr 18, 2019

I mean the latter but I don't want us to be monitoring changes and updating CHANGELOGs after the fact. I think having a note above changelogs is a solution but a better one is to add checks to avoid missing adding entries in the future.

Are saying that a package might get a version bump even if there's no changes in that package

But, this is also true as Lerna updates all the packages that depend on updated packages even with no changes in the said packages, which makes the note needed regardless.

Edit I guess I mean both :)

@nerrad
Copy link
Contributor Author

nerrad commented Apr 18, 2019

So can I make a suggestion for a note to add at the top of every changelog and then eventually we can do pulls to add it to our packages?

Suggestion (we can iterate):

Note: This change-log is a record of code changes made to the package for each version. Releases involving package dependency updates only are not reflected in this log.

@gziolo gziolo removed this from the 5.6 (Gutenberg) milestone May 6, 2019
@gziolo
Copy link
Member

gziolo commented May 28, 2019

I think #15740 resolves the issue since we are now using ## Master header to mitigate the fact that we can't always predict the next version of the package published.

@gziolo gziolo closed this as completed May 28, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Data /packages/data [Type] Bug An existing feature does not function as intended
Projects
None yet
Development

No branches or pull requests

3 participants