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

Update published packages changelogs #12247

Merged
merged 1 commit into from
Nov 26, 2018
Merged

Update published packages changelogs #12247

merged 1 commit into from
Nov 26, 2018

Conversation

gziolo
Copy link
Member

@gziolo gziolo commented Nov 23, 2018

We missed this for the last 2 releases of packages. They contained only small bug fixes so it isn't a big deal but I added them for the record.

@gziolo gziolo added this to the 4.6 milestone Nov 23, 2018
@gziolo gziolo added the [Type] Developer Documentation Documentation for developers label Nov 23, 2018
@gziolo gziolo requested review from a team and noisysocks November 23, 2018 12:42
Copy link
Member

@tofumatt tofumatt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏻

@noisysocks
Copy link
Member

It's unfortunate that updating these CHANGELOG.md files means that Lerna treats the packages as having changed. For example, because this PR updates packages/annotations/CHANGELOG.md, @wordpress/annotations will be published the next time we do a packages release.

In fact, while doing the last publish, I noticed a few packages where the last few patch releases have been entirely CHANGELOG.md updates similar to this one. This is because we updated the CHANGELOG.md files after publishing.

Not sure how to address this other than to get into the habit of updating the CHANGELOG.md files before publishing. Ideally our process would be automated 😅

@noisysocks
Copy link
Member

@wordpress/list-reusable-blocks is a good example. Check it out—the last 11 releases have been completely unnecessary 😛

https://github.com/WordPress/gutenberg/commits/master/packages/list-reusable-blocks

@ntwb
Copy link
Member

ntwb commented Nov 26, 2018

@noisysocks Changes to any CHANGELOG.md should be ignored by Lerna: (docs)

gutenberg/lerna.json

Lines 7 to 11 in b5a709f

"ignoreChanges": [
"**/benchmark/*.js",
"**/CHANGELOG.md",
"**/test/**"
],

@noisysocks
Copy link
Member

Interesting—there must be some other problem with our configuration. Right now if I run npm run publish:check, I get:

@wordpress/block-library
@wordpress/blocks
@wordpress/components
@wordpress/edit-post
@wordpress/editor
@wordpress/format-library
@wordpress/html-entities
@wordpress/list-reusable-blocks
@wordpress/nux

Of those, @wordpress/list-reusable-blocks and @wordpress/nux have not been recently changed, which you can see by looking in the GitHub history:

https://github.com/WordPress/gutenberg/commits/master/packages/list-reusable-blocks
https://github.com/WordPress/gutenberg/commits/master/packages/nux

@ntwb
Copy link
Member

ntwb commented Nov 26, 2018

Indeed they have not changed recently, but the package.json dependencies in @wordpress/nux:

"@wordpress/components": "file:../components",
"@wordpress/compose": "file:../compose",
"@wordpress/data": "file:../data",
"@wordpress/element": "file:../element",
"@wordpress/i18n": "file:../i18n",

Which are currently:

https://unpkg.com/@wordpress/[email protected]/package.json

@wordpress/components | "^7.0.2"
@wordpress/compose | "^3.0.0"
@wordpress/data | "^4.0.1"
@wordpress/element | "^2.1.8"
@wordpress/i18n | "^3.1.0"

And as @wordpress/components does include recent changes, the @wordpress/components | "^7.0.2" will get bumped to 7.0.3, 7.1.0, or 8.0.0 depending on semver bump of that package

@noisysocks
Copy link
Member

🤦‍♂️ that makes total sense—thanks for explaining @ntwb!

@gziolo gziolo merged commit 4a9de65 into master Nov 26, 2018
@gziolo gziolo deleted the update/changelogs branch November 26, 2018 09:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants