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

Add support for the WordPress.org plugin preview #175

Merged
merged 3 commits into from
Jan 4, 2024

Conversation

dkotter
Copy link
Collaborator

@dkotter dkotter commented Dec 19, 2023

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. Imports the Media Kit page from a test import file. The plugin is supposed to create this itself on activation but seems that the activation process that happens when the Playground is initialized doesn't trigger that functionality (may be worth opening an issue on the Playground repo to see if this is a bug)
  5. Sends the user to the Media Kit page

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. This won't work though until 10up/action-wordpress-plugin-asset-update#54 is released.

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=7&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%22publisher-media-kit%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\/publisher-media-kit\/65a081ba5d9f03270873d96baf7189d20fafcd7c\/.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.3.4 milestone Dec 19, 2023
@dkotter dkotter self-assigned this Dec 19, 2023
@dkotter dkotter requested a review from jeffpaul as a code owner December 19, 2023 21:55
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!

@jeffpaul
Copy link
Member

jeffpaul commented Jan 2, 2024

@faisal-alvi FYI might be helpful to check on Darin's comment from above:

  1. Imports the Media Kit page from a test import file. The plugin is supposed to create this itself on activation but seems that the activation process that happens when the Playground is initialized doesn't trigger that functionality (may be worth opening an issue on the Playground repo to see if this is a bug)

@dkotter dkotter merged commit d5a6f5d into trunk Jan 4, 2024
1 check passed
@dkotter dkotter deleted the feature/plugin-preview branch January 4, 2024 21:41
@faisal-alvi
Copy link
Member

@jeffpaul the issue is reported: WordPress/wordpress-playground#911

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

Successfully merging this pull request may close these issues.

3 participants