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 a Playground blueprint json to the /assets/blueprints folder of Plugin Repo #67742

Merged
merged 3 commits into from
Dec 11, 2024

Conversation

bph
Copy link
Contributor

@bph bph commented Dec 9, 2024

What?

Adds a blueprint.json to the assets/blueprints folder, to show a preview in the Plugins Directory for the plugin.
Fix #67739

Why?

To empower users to test and try out the latest Gutenberg plugin version.

How?

Following the Plugin Review Teams instructions.

Testing Instructions

Test via Playground (updated 12/11/24)

  • Needs a second step from plugin committers on record to switch the blueprint from test to public.

Copy link

github-actions bot commented Dec 9, 2024

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: bph <[email protected]>
Co-authored-by: brandonpayton <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@bph bph changed the title create dirs, add blueprint.json Add a Playground blueprint json to the /assets/blueprints folder of Plugin Repo Dec 9, 2024
@bph bph added [Type] Enhancement A suggestion for improvement. Gutenberg Plugin Issues or PRs related to Gutenberg Plugin management related efforts labels Dec 9, 2024
Copy link

github-actions bot commented Dec 9, 2024

Warning: Type of PR label mismatch

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

  • Type-related labels to choose from: [Type] Automated Testing, [Type] Breaking Change, [Type] Bug, [Type] Build Tooling, [Type] Code Quality, [Type] Copy, [Type] Developer Documentation, [Type] Enhancement, [Type] Experimental, [Type] Feature, [Type] New API, [Type] Task, [Type] Technical Prototype, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket, Backport from WordPress Core, Gutenberg Plugin.
  • Labels found: [Type] Enhancement, Gutenberg Plugin.

Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task.

@bph bph requested a review from gziolo December 9, 2024 14:31
Copy link
Member

@brandonpayton brandonpayton left a comment

Choose a reason for hiding this comment

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

Thanks, @bph! This tests well for me. I approved the PR but left some notes about potential improvements, depending on what you think.

assets/blueprints/blueprint.json Show resolved Hide resolved
assets/blueprints/blueprint.json Outdated Show resolved Hide resolved
@bph bph merged commit f2ba0fd into trunk Dec 11, 2024
62 checks passed
@bph bph deleted the add/plugin-blueprint branch December 11, 2024 12:42
@github-actions github-actions bot added this to the Gutenberg 20.0 milestone Dec 11, 2024
@t-hamano
Copy link
Contributor

@sirreal @gziolo Do you know if the assets directory is included in the files released to .org? Maybe we need to explicitly include it here:

zip --recurse-paths --no-dir-entries \
gutenberg.zip \
gutenberg.php \
lib \
packages/block-serialization-default-parser/*.php \
post-content.php \
build \
build-module \
readme.txt \
changelog.txt \
README.md

@bph
Copy link
Contributor Author

bph commented Dec 11, 2024

Oh, good catch @t-hamano - Thank you!

@bph
Copy link
Contributor Author

bph commented Dec 11, 2024

I downloaded the plugin build artifact from this PR and the assets folder didn't come with it.

@sirreal
Copy link
Member

sirreal commented Dec 11, 2024

I'm not sure how the plugin publish flow works for Gutenberg, but the asset directory is separate from what goes into the plugin zip on the plugin repository, so it's not surprising that it wouldn't be listed as part of the plugin zip.

@bph
Copy link
Contributor Author

bph commented Dec 11, 2024

I added a new issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Gutenberg Plugin Issues or PRs related to Gutenberg Plugin management related efforts [Type] Enhancement A suggestion for improvement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a blueprint to Gutenberg plugin space
4 participants