Skip to content

Add support for the WordPress.org plugin preview#196

Merged
dkotter merged 5 commits intotrunkfrom
feature/plugin-preview
Jan 2, 2024
Merged

Add support for the WordPress.org plugin preview#196
dkotter merged 5 commits intotrunkfrom
feature/plugin-preview

Conversation

@dkotter
Copy link
Collaborator

@dkotter dkotter commented Dec 18, 2023 •
edited
Loading

Description of the Change

WordPress.org recently launched support for plugin previews utilizing the WordPress Playground feature. Plugins wanting to take advantage of this need to opt in by setting up a blueprint.json file that configures how the preview should load. This PR adds in that file that does the following:

  1. Sets up an environment running PHP 7.4 (our supported minimum) and the latest version of WordPress
  2. Logs into the admin
  3. Installs and activates the plugin
  4. Sends the user to a post that has the Apple Maps block in place

Note that this PR is targeted to trunk so we can take advantage of our Plugin Asset Update Action to deploy these changes without having to push out a new release.

Also note once these changes are on .org, the preview button will need to be enabled in a test state. Once verified as working, we can enable it for all users.

How to test the Change

The WordPress Playground allows you to spin up a new environment directly through the URL, by going to https://playground.wordpress.net/# and pasting your JSON config after the #. In this case, the URL should be: https://playground.wordpress.net/#{%20%22$schema%22:%20%22https://playground.wordpress.net/blueprint-schema.json%22,%20%22landingPage%22:%20%22\/wp-admin\/post.php?post=6&action=edit%22,%20%22preferredVersions%22:%20{%20%22php%22:%20%227.4%22,%20%22wp%22:%20%22latest%22%20},%20%22phpExtensionBundles%22:%20[%22kitchen-sink%22],%20%22steps%22:%20[%20{%20%22step%22:%20%22login%22,%20%22username%22:%20%22admin%22,%20%22password%22:%20%22password%22%20},%20{%20%22step%22:%20%22installPlugin%22,%20%22pluginZipFile%22:%20{%20%22resource%22:%20%22wordpress.org\/plugins%22,%20%22slug%22:%20%22maps-block-apple%22%20},%20%22options%22:%20{%20%22activate%22:%20true%20}%20},%20{%20%22step%22:%20%22importFile%22,%20%22file%22:%20{%20%22resource%22:%20%22url%22,%20%22url%22:%20%22https:\/\/raw.githubusercontent.com\/10up\/maps-block-apple\/385fb9705624c2fe6822ac399ed08f09a5e80388\/.wordpress-org/blueprints\/demo-data.xml%22%20}%20}%20]%20}

Changelog Entry

Added - Support for the WordPress.org plugin preview

Credits

Props @dkotter

Checklist:

  • I agree to follow this project's Code of Conduct.
  • I have updated the documentation accordingly.
  • I have added tests to cover my change.
  • All new and existing tests pass.

@dkotter dkotter added this to the 1.2.0 milestone Dec 18, 2023
@dkotter dkotter self-assigned this Dec 18, 2023
@dkotter dkotter requested a review from jeffpaul as a code owner December 18, 2023 22:34
@jeffpaul
Copy link
Member

jeffpaul commented Dec 18, 2023

@dkotter worth asking if you think it might be better to drop them into the editor with an empty Apple Maps block that they'll need to configure to test/demo?

@dkotter
Copy link
Collaborator Author

dkotter commented Dec 18, 2023

@dkotter worth asking if you think it might be better to drop them into the editor with an empty Apple Maps block that they'll need to configure to test/demo?

Makes sense (though in testing, seems we have an over aggressive check for the credentials. I get the message Missing Private Key over and over as I try and edit a post with that block). The new test URL is https://playground.wordpress.net/#{%20%22$schema%22:%20%22https://playground.wordpress.net/blueprint-schema.json%22,%20%22landingPage%22:%20%22\/wp-admin\/post.php?post=6&action=edit%22,%20%22preferredVersions%22:%20{%20%22php%22:%20%227.4%22,%20%22wp%22:%20%22latest%22%20},%20%22phpExtensionBundles%22:%20[%22kitchen-sink%22],%20%22steps%22:%20[%20{%20%22step%22:%20%22login%22,%20%22username%22:%20%22admin%22,%20%22password%22:%20%22password%22%20},%20{%20%22step%22:%20%22installPlugin%22,%20%22pluginZipFile%22:%20{%20%22resource%22:%20%22wordpress.org\/plugins%22,%20%22slug%22:%20%22maps-block-apple%22%20},%20%22options%22:%20{%20%22activate%22:%20true%20}%20},%20{%20%22step%22:%20%22importFile%22,%20%22file%22:%20{%20%22resource%22:%20%22url%22,%20%22url%22:%20%22https:\/\/raw.githubusercontent.com\/10up\/maps-block-apple\/385fb9705624c2fe6822ac399ed08f09a5e80388\/.wordpress-org/blueprints\/demo-data.xml%22%20}%20}%20]%20}

@dkotter dkotter mentioned this pull request Dec 18, 2023
Merged
4 tasks
@jeffpaul
Copy link
Member

jeffpaul commented Jan 2, 2024

@dkotter I see your comment on the Missing Private Key notifications... maybe we delay on checking there until someone clicks the Confirm MapKit Credentials button?

@dkotter
Copy link
Collaborator Author

dkotter commented Jan 2, 2024

@dkotter I see your comment on the Missing Private Key notifications... maybe we delay on checking there until someone clicks the Confirm MapKit Credentials button?

Yeah, seems we can handle this check a bit better, though that's not related specifically to this PR. I'd suggest we open a new issue to track that and can proceed here, assuming no other changes are needed

@jeffpaul jeffpaul mentioned this pull request Jan 2, 2024
Open
1 task
jeffpaul
jeffpaul approved these changes Jan 2, 2024
View reviewed changes
Copy link
Member

@jeffpaul jeffpaul left a comment

Choose a reason for hiding this comment

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

Looks good, thanks for getting this set up!

@dkotter dkotter merged commit e6596fe into trunk Jan 2, 2024
@dkotter dkotter deleted the feature/plugin-preview branch January 2, 2024 19:49
@jeffpaul
Copy link
Member

jeffpaul commented Jan 2, 2024

Looks good now: https://wordpress.org/plugins/maps-block-apple/

@dkotter dkotter modified the milestones: 1.2.0, 1.1.4 Aug 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jeffpaul jeffpaul jeffpaul approved these changes

Assignees

@dkotter dkotter

Labels

None yet

Projects

None yet

Milestone

1.1.4

Development

Successfully merging this pull request may close these issues.

2 participants

@dkotter @jeffpaul