Enable a plugin preview using playground

[carstingaxion]

Description of the Change

Enabling Plugin Previews

There are two things required for a plugin preview button to appear to all users:

• A valid blueprint.json file must be provided in a blueprints sub-directory of the plugin’s assets folder.
• The plugin preview must be set to “public” from the plugin’s Advanced view by a committer.

Closes #

How to test the Change

1. Get the content of the blueprint.json file
2. Paste it into the Playground builder (and replace everything else)
3. Get a working GatherPress ~~ latest~~ version 0.28.0 installed
4. Your landing-page should be /events/ with an image showing the Events List block in the block-inserter and a heading:

   Show all your events using the Events List block provided by GatherPress

5. You won't find any imported events, since Export & Import #655

Changelog Entry

Added - Enable plugin preview for wordpress.org using WordPress Playground.

Credits

Props @carstingaxion

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.

[carstingaxion]

We & I should probably first finish & merge #655 , otherwise we would not be able to pre-fill a playground with data. Because of #650

[carstingaxion]

You must commit your blueprint.json file to your plugin’s assets folder, named like this:

/assets/blueprints/blueprint.json

https://developer.wordpress.org/plugins/wordpress-org/previews-and-blueprints/#committing-a-blueprint-to-subversion

Am I right that the existing /.wordpress-org folder works the same like the mentioned /assets folder?

[carstingaxion]

Try to remove the need for the action, by using github-proxy.com seems to be not straight forward.

• ✅ https://github-proxy.com/proxy/?repo=GatherPress/gatherpress&release=0.28.0&asset=gatherpress.zip
• ⛔ https://github-proxy.com/proxy/?repo=GatherPress/gatherpress&release=latest&asset=gatherpress.zip

---

Internally github-proxy.com uses:

$url = "https://github.com/$repo/releases/download/$release/$asset";

which works fine with numbered, but not the latest release.

Acording to download - Is there a link to GitHub for downloading a file in the latest release of a repository? - Stack Overflow the url template needs some change.

$url = "https://github.com/$repo/releases/download/$release/$asset";

• ✅ https://github.com/GatherPress/gatherpress/releases/download/0.28.0/gatherpress.zip
• ✅ https://github.com/GatherPress/gatherpress/releases/latest/download/gatherpress.zip

[carstingaxion]

Hello @mauteri ,

I would call this almost ready ... except some questions. I would like to read your opinions on one or the other. Or all ;)

• Am I right that the existing /.wordpress-org folder works the same like the mentioned /assets folder?
• Should we accept, that we can currently only use a numbered version, as long as GatherPress is not in the wp.org-repo or Allow to use the 'latest' release (with a named asset) stoph/github-proxy#9 gets fixed?
• I think Export & Import #655 should be next (or even first)
• The (yet unused) demo-data is referenced from carstingaxion/gatherpress-demo-data. Keep it? Move the repo? Or just remove it for now? (Issue on that: Create reusable demo data #649)

[carstingaxion]

Because this blueprint.json will be used (most) exclusively by wp.org itself, I think its suitable to already set the used source for the plugin to the repo and remove the call via github-proxy.com.

That's what I did in my last commit and mentioned first time in #663 (comment).

[mauteri]

NOTE: Can be merged after Export & Import PR is merged.

[mauteri]

@carstingaxion now that Export/Import PR has been merged are we now able to merge this PR?

[carstingaxion]

I think so, yes @mauteri .

I had a look at the blueprint.json again, which looks good to me.

But there is no risk, with that, because the plugin preview on w.org is hidden behind a feature flag, that only you (as plugin author) can enable. So you (and others, if you share the link) can test that, before going live.