Skip to content

Add support for the WordPress.org plugin preview#265

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

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

Conversation

@dkotter
Copy link
Copy Markdown
Collaborator

@dkotter dkotter commented Dec 21, 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. Sends the user to our onboarding wizard

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\/admin.php?page=simple-podcasting-onboarding&step=1%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%22features%22:%20{%20%22networking%22:%20true%20},%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%22simple-podcasting%22%20},%20%22options%22:%20{%20%22activate%22:%20true%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 self-assigned this Dec 21, 2023
@dkotter dkotter requested a review from jeffpaul as a code owner December 21, 2023 17:10
Copy link
Copy Markdown
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 jeffpaul added this to the 1.7.0 milestone Jan 2, 2024
@dkotter dkotter merged commit 973dcd4 into trunk Jan 2, 2024
@dkotter dkotter deleted the feature/plugin-preview branch January 2, 2024 18:11
@jeffpaul
Copy link
Copy Markdown
Member

jeffpaul commented Jan 2, 2024

Looks good now: https://wordpress.org/plugins/simple-podcasting/

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.

2 participants