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

Framework: Drop deprecations slated for 3.2 removal #7747

Merged
merged 2 commits into from
Jul 6, 2018

Conversation

aduth
Copy link
Member

@aduth aduth commented Jul 6, 2018

This pull request seeks to remove deprecations slated for removal in the upcoming 3.2.0 release.

Specifically, this includes:

  • wp.data.withRehydratation has been renamed to wp.data.withRehydration.
  • The wp.editor.ImagePlaceholder component is removed. Please use wp.editor.MediaPlaceholder instead.
  • wp.utils.deprecated function removed. Please use wp.deprecated instead.
  • getInserterItems: the allowedBlockTypes argument was removed and the parentUID argument was added.
  • getFrecentInserterItems selector removed. Please use getInserterItems instead.
  • getSupportedBlocks selector removed. Please use canInsertBlockType instead.

See: https://wordpress.org/gutenberg/handbook/reference/deprecated/#3-2-0

Testing instructions:

Verify that there are no regressions in impacted behavior, and importantly that no references to deprecated behaviors exist in core code.

@aduth aduth added Framework Issues related to broader framework topics, especially as it relates to javascript [Type] Breaking Change For PRs that introduce a change that will break existing functionality labels Jul 6, 2018
@aduth aduth added this to the 3.2 milestone Jul 6, 2018
@tofumatt tofumatt self-requested a review July 6, 2018 13:23
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.

Looks like utils/deprecated.js is slated to be removed but the file and function are still there: https://github.com/WordPress/gutenberg/blob/remove/3-2-deprecations/utils/deprecated.js

Otherwise looks good.

@jorgefilipecosta
Copy link
Member

I did some grepping and testing and things seem fine. I think the only thing missing is the removal of the deprecated wrapper from /utils/deprecated.

@mcsf
Copy link
Contributor

mcsf commented Jul 6, 2018

We should mention this step of checking for deprecations in the release document.

@aduth
Copy link
Member Author

aduth commented Jul 6, 2018

Looks like utils/deprecated.js is slated to be removed but the file and function are still there: https://github.com/WordPress/gutenberg/blob/remove/3-2-deprecations/utils/deprecated.js

Nice catch. Our custom lint rule is dumb and can't find by the aliased originalDeprecated, hence my missing it. It's been updated in 1c5f0a7.

@aduth
Copy link
Member Author

aduth commented Jul 6, 2018

We should mention this step of checking for deprecations in the release document.

I might agree, but the document as written is more oriented to steps to undertake when already in the process of doing a release. Since the lint rule will forbid the merge of the version bump pull request anyways, I'm not sure it's of huge help. Maybe we should add a section on things to look out further ahead of the next release? (Maybe more as a step after a release)

@tofumatt
Copy link
Member

tofumatt commented Jul 6, 2018

Easily solved with a Release Checklist section, which totally belongs in the release docs. 🚲🏠

@aduth
Copy link
Member Author

aduth commented Jul 6, 2018

That would work, but only if it's the last step, not a pre-release step. Otherwise we risk reenforcing the idea that this be done at the time of a release, which I disagree with. 3.3 deprecations, for example, should ideally be removed immediately after the upcoming 3.2 release.

@aduth aduth merged commit dfb7b05 into master Jul 6, 2018
@aduth aduth deleted the remove/3-2-deprecations branch July 6, 2018 14:37
@tofumatt
Copy link
Member

tofumatt commented Jul 6, 2018

Oh, wait, right. Okay! I will add...

@@ -1,6 +1,6 @@
{
"name": "gutenberg",
"version": "3.1.1",
"version": "3.2.0",
Copy link
Member Author

Choose a reason for hiding this comment

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

Sigh.. this wasn't meant to be included 😞 Only to help trigger the failing E2E locally.

Copy link
Member

Choose a reason for hiding this comment

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

Sorry I missed it too 😢

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Framework Issues related to broader framework topics, especially as it relates to javascript [Type] Breaking Change For PRs that introduce a change that will break existing functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants