wordpress / blueprints Goto Github PK

Example: #28

Errors:

RequestError [HttpError]: Resource not accessible by integration
    at /home/runner/work/_actions/actions/github-script/60a0d83039c74a4aee543508d2ffcb1c3799cdea/dist/index.js:9537:21
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
    at async eval (eval at callAsyncFunction (/home/runner/work/_actions/actions/github-script/60a0d83039c74a4aee543508d2ffcb1c3799cdea/dist/index.js:35424:16), <anonymous>:56:3)
    at async main (/home/runner/work/_actions/actions/github-script/60a0d83039c74a4aee543508d2ffcb1c3799cdea/dist/index.js:35522:20) {
  status: 403,
  response: {
    url: 'https://api.github.com/repos/adamziel/blueprints/issues/28/comments',

This might be solved by switching to pull_request_target automation

and

Run python validate_pr.py
Error: blueprints/wpcli-markdown/blueprints/wpcli-markdown/blueprint.json file does not exist in this PR.

The latter one would be solved by rebasing, but we don't want to require everyone to rebase before merging.

Hello.
I have been experimenting with playground, thanks for building this :-)

I have this blueprint https://github.com/amnestywebsite/humanity-blueprint/blob/main/blueprint.json
https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/amnestywebsite/humanity-blueprint/main/blueprint.json

Which is trying to install this theme https://github.com/amnestywebsite/humanity-theme/releases

Which has been uploaded here https://github.com/amnestywebsite/humanity-blueprint/blob/main/humanity-theme.zip

The backend editor experience seems to work as I can

1. create a post
2. add a tile
3. add a custom block
4. add data to the custom block

When I try to view the post I see a spinning icon and looking at the console while running the blue print gives me the below.

The theme seems to show in the editor 
Error: PHP.run() failed with exit code 255 and the following output: 
logToConsole @ /worker-thread-d40a8…te-slug=wordpress:1
index.js:222  PHP.run() failed with exit code 255 and the following output:  Error: PHP.run() failed with exit code 255 and the following output: 
    at PHP.run (https://playground.wordpress.net/worker-thread-d40a8ab7.js?wpVersion=6.4&phpVersion=8.2&php-extension=iconv&php-extension=mbstring&php-extension=xml-bundle&php-extension=gd&networking=yes&storage=&site-slug=wordpress:53:1748)
    at async PlaygroundWorkerEndpoint.run (https://playground.wordpress.net/worker-thread-d40a8ab7.js?wpVersion=6.4&phpVersion=8.2&php-extension=iconv&php-extension=mbstring&php-extension=xml-bundle&php-extension=gd&networking=yes&storage=&site-slug=wordpress:4:8867)
$o @ index.js:222
index.js:219  Error: PHP.run() failed with exit code 255 and the following output: 
    at PHP.run (/worker-thread-d40a8ab7.js?wpVersion=6.4&phpVersion=8.2&php-extension=iconv&php-extension=mbstring&php-extension=xml-bundle&php-extension=gd&networking=yes&storage=&site-slug=wordpress:53:1748)
    at async PlaygroundWorkerEndpoint.run (/worker-thread-d40a8ab7.js?wpVersion=6.4&phpVersion=8.2&php-extension=iconv&php-extension=mbstring&php-extension=xml-bundle&php-extension=gd&networking=yes&storage=&site-slug=wordpress:4:8867)
$o @ index.js:219
builder.html-f350f1dc.js:5  Error: Error when executing the blueprint step #6 ({"step":"importWxr","file":{"resource":"url","url":"https://raw.githubusercontent.com/amnestywebsite/humanity-blueprint/main/humanitythemeContent.xml"}}) : PHP.run() failed with exit code 255 and the following output: 
    at Object.run (index.js:8782:32)
    at async Sd (index.js:8892:3)
    at async Ud (index.js:9255:43)
    at async k (builder.html-f350f1dc.js:6:561)Caused by: Error: PHP.run() failed with exit code 255 and the following output: 
    at PHP.run (/worker-thread-d40a8ab7.js?wpVersion=6.4&phpVersion=8.2&php-extension=iconv&php-extension=mbstring&php-extension=xml-bundle&php-extension=gd&networking=yes&storage=&site-slug=wordpress:53:1748)
    at async PlaygroundWorkerEndpoint.run (/worker-thread-d40a8ab7.js?wpVersion=6.4&phpVersion=8.2&php-extension=iconv&php-extension=mbstring&php-extension=xml-bundle&php-extension=gd&networking=yes&storage=&site-slug=wordpress:4:8867)

It would be amazing if I could even get a single post or page to load.

Once I get this working I was planning to submit it to your gallery.

I am able to send a full back up on another channel if that helps?

Thanks,

Let's co-create a Blueprint review checklist for the future reviewers. Here's the initial draft:

How to get started?

• Subscribe to all the new PRs and issues in this repository to get notifications about new submissions

What to review?

• New Pull Requests without any labels
• Pull Requests with a "needs review" label

How to review?

• Does the PR fulfill the contribution guidelines?
  • It has a dedicated directory for the Blueprint
  • There's only a single Blueprint.json file
  • No files outside of the WordPress/Blueprints repository (or reasonable wp.org URLs) are referenced
  • Does the Blueprint come with a clear title and description?
• Do the automated GitHub checks pass?
• Does the Blueprint actually work when previewed? Does it load reasonably fast? Are there any errors in the browser devtools?

What to do next?

If the answer to all these questions is "yes", you can just merge the Pull Request. The gallery will be automatically refreshed by a CI job. You're done!

If the answer to any of these questions is "no":

• Leave feedback for the person submitting the Pull Request.
• Tell them exactly what's wrong and give them tips on how to improve it. Over time we should accumulate a nice "copy&paste" database of those tips to streamline the process.
• If they reply, re-review.
• If they don't reply within 14 days, close the PR.

This simple workflow may suffice. If it doesn't, let's explore:

• Automatically adding "awaiting review" and "needs changes" labels when the PR is created and commented on
• A project board with columns representing PRs with those labels

Let's provide developers with ample examples on how to build Blueprints. One outline is proposed in WordPress/blueprints-library#64

I’d like to see (and maybe start working on) a blueprint that replicates the WordPress devhub for a custom plugin. As a real use-case I’d like to explore creating developer.gatherpress.org with the phpdoc-parser running against the plugin code of GatherPress.

Props for contributing to WordPress is a new concept that enables those who want to contribute an easy way to get started.

Maybe someone is just getting started and don't fully understand Pull Requests in GitHub, maybe they have that one really great idea they want to share, but don't know how to build it.

Let's figure out a way for them to get involved with the Blueprints Community and give credit for their contributions.

From Making WordPress post

In January 2022, a proposal was published on this blog to implement a new process within any GitHub repository under the WordPress organization to ensure anyone and everyone contributing to the project receives due thanks in the form of “props.”

One of the greatest things about open source is that contributions come in many shapes and sizes. Anyone can contribute regardless of skill set, experience, time zone, or background. There are countless ways for someone to get involved with open source projects.

WordPress is no different. Contributors submitting code modifications are only a small subset of the larger community. Recognizing all types of contributions is essential to establishing a healthy contributor base, and the responsibility falls on the project’s maintainers. Contributors who feel recognized and valued are more likely to continue contributing.

I'd like to introduce a proposal to give credit in some way to those who contribute to the Blueprints Community!

Existing limitations

The Props Bot is currently only available in the WordPress organization? How to expand props to the Blueprints Community?

Feedback is much appreciate as always 👍

What metadata is useful to keep track of? For now we have:

• Title – A clear and concise name for the Blueprint.
• Description – A brief explanation of what your Blueprint offers.
• Author – GitHub username.
• Categories – for future filtering. Which categories should be allowed? Perhaps this could be omitted from v1 and added later on once there's more Blueprints and some categories emerge naturally.

Would Blueprint version, similar to a plugin version, be useful at all? I'm not sure. Semantic versioning, as in 0.1.17 makes sense for software packages, but it doesn't seem to make sense for Blueprints. Also, contrary to plugins, there is nothing to auto-update after a new Blueprint is released.

Reviewing Blueprints requires manually copying and pasting their contents. Let's add a GitHub automation to provide a convenient link that can be just clicked.

Submitted Blueprints will likely use different formatting styles and a mixture of spaces and tabs. Let's minimize any future discussions about formatting and:

• Provide formatting guidelines in the contributing docs. Explain how to do spaces vs tabs in popular code editors.
• The repository could provide a .prettierrc and .eslintrc for folks using local formatters.
• We could have an automation that automatically applies consistent formatting once a PR is merged.

CC @bph

@adamziel I tried to delete the jumbled theme-test branch, but I got a 403 permission errors...

Sorry for making a mess. All I can say is - I learned a lot... and Thank YOU for your patience.

https://raw.githubusercontent.com/wpaccessibility/a11y-theme-unit-test/trunk/a11y-theme-unit-test-data.xml

https://raw.githubusercontent.com/WordPress/theme-test-data/trunk/themeunittestdata.wordpress.xml

cc @bph I wonder if it's intermittent or were they actually moved to another repo or directory

In Contributing.md it says:

For example, if you want to load a content-export.xml file and your branch is called woocommerce-subscriptions, then your PR must contain a

A blueprints/woocommerce-subscriptions/blueprint.json file
A blueprints/woocommerce-subscription/content-export.xml file the Blueprint should reference as follows:
{
	"steps": [
		{
			"step": "importWxr",
			"file": {
				"resource": "url",
				"url": "https://raw.githubusercontent.com/adamziel/blueprints/woocommerce-subscriptions/blueprints/woocommerce-subscriptions/content-export.xml"
			}
		}
	]
}

This makes it seem that the branch name and the folder name need to be the same. That doesn't seem to be necessarily the case. If i am correct I would suggest to change the example

That the example branch is called something different than the folder, like /woo-subsriptions/
and the url: is modified to https://raw.githubusercontent.com/adamziel/blueprints/woo-subsriptions/blueprints/woocommerce-subscriptions/content-export.xml

And add another sentence in
The folder of your files would be /woocommerce-subscription

It would read like this

For example, if you want to load a content-export.xml file,
you create a new folder in the blueprints directory, /woocommerce-subscription (the name should correpong to the name of the blueprint and must hold two files.
A blueprints/woocommerce-subscriptions/blueprint.json file
A blueprints/woocommerce-subscription/content-export.xml file
Your branch you named /woo-subscription/ (this name is up to you)

Then the Blueprint should reference as follows:

	"steps": [
		{
			"step": "importWxr",
			"file": {
				"resource": "url",
				"url": "https://raw.githubusercontent.com/adamziel/blueprints/woo-subscriptions/blueprints/woocommerce-subscriptions/content-export.xml"
			}
		}
	]
}```

Contributing Guidelines say:

All static files (WXR, ZIP, JPG etc.) referenced by the Blueprint must be included in the submitted directory in your Pull Request and referenced via the raw.githubusercontent.com domain.

However, it's unclear how to actually reference these files in blueprint.json in a PR. That blueprint can ship URLs pointing to the newly proposed branch, but once that branch is merged these URLs will need to magically start pointing to trunk.

Two solutions that came to mind:

1. CI job to rewrite the URLs. I don't like it, though. It's extra work and will make forking and adjusting these files more difficult.
2. Support URLs relative to the Blueprint. For example { "step": "installPlugin", "pluginZipFile": "./plugin.zip" }. This would be a breaking change because relative URLs are now relative to the client site URL. Maybe that's fine, though? Or perhaps we could ship a new resource type, like "blueprint-relative-url"?

cc @bgrgicak @brandonpayton @dmsnell for ideas

I shipped a slide deck in https://github.com/adamziel/playground-sites, it would be great to turn it into a generic Blueprint folks could run and start building their own slide decks.

Update steps:

• replace importFile w/ importWxr step
• use plugins shorthand notation.
  "plugins": [ debug-bar" , "health-check" , "create-block-theme" , "gutenberg" ]

While you can submit any Blueprint to this repository, here's a few ideas that would be particularly helpful and people have requested in the past (e.g. in the Add 10 initial Blueprints issue)

Highly useful Blueprints

• XML import with a good demo content (not test content) requested by @justintadlock. This example by @ndiego or this one from @ryanwelcher or this one from @helgatheviking could be helpful.
• Block Museum as a Blueprint https://block-museum.com/

Furthermore, the following ideas seem particularly interesting:

Showcase great WordPress features

• #46
• Block hooks example
• Twenty Twenty with...
  • Block template parts
  • theme.json
  • theme.json and various block options for color limited
  • locked blocks or patterns
  • both theme provided and custom starter patterns, along with patterns prioritized from the pattern directory
  • various block options limited (duotone, color, typography tools) and client side filtering for some blocks
• Setup for creating a new theme with a create-block-theme plugin

Create Content

• Generate content with Fakerpress (plugin demo, content)
• Convert Markdown to WordPress posts (read file via wp-cli)
• Migrate all Markdown related docs pages to WordPress

Maintenance, Optimization, Configuration

• Start with a fresh WordPress install via Site Cleanup plugin
• Speculative Loading for faster site
• Run Performance Lab on a site

Testing, Debugging

• Enforce WordPress Coding Standards (use Plugin Review Check)
• Theme Check plugin
• Debugging with the Debug Bar plugin
• Log in as a user with editor role

Learn WordPress JavaScript APIs

• Working with the datastore (see the course and the existing Blueprint)
  • Get data from WordPress in JavaScript (use hooks)
  • useSelect example
  • Working with a custom datastore

Props to @flexseth, @annezazu, @justintadlock, @ryanwelcher, @helgatheviking, and @bph for sharing these!

Recently I was working on a Blueprint from the Gallery, and wasn't sure if I had changed the code or if something wasn't working correctly. If there was a link to more info about the blueprint, that would be helpful!

Suggesting a new meta value, name TBD. Currently the standard is lowercase..

• url
• link
• blueprint-url
• blueprint-URI
• more-info
• origin

The source of truth and more information about the blueprint.

The URL could link to part of a repository for more info or a raw blueprint.json file (for simpler blueprints)

Sample

Run unit, accessibility, and theme review tests

"meta": {
        "title": "Theme Ready",
        "description": "Runs all theme tests and reports back",
        "author": "WP.org Themes Team",
        "categories": [
          "themes",
          "content"
        ],
        "link": "themetest.playground.wordpress.net"
      }, 
"steps": {
      ...
}

Where themetest.playground.wordpress.net provides more information about what the blueprint does

A few places they could be sourced from:

• https://github.com/WordPress/block-theme-examples?tab=readme-ov-file
• https://github.com/WordPress/block-development-examples
• https://wordpress.github.io/wordpress-playground/blueprints-api/examples
• https://wordpress.github.io/wordpress-playground/blueprints-api/index
• https://wordpress.github.io/wordpress-playground/build-your-first-app

Let's add those Blueprints via separate Pull Requests to serve as examples for the publishing guidelines.

Let's include additional static assets with at least one of them to demonstrate how to ship and use those via raw.githubusercontent.com.

Open questions

• Should this repository support shipping two Blueprints in a single directory? cc @tellyworth

cc @bph @justintadlock

1. add a note to https://github.com/adamziel/blueprints/blob/trunk/CONTRIBUTING.md

Once merged into trunk the path to blueprint folder is
https://raw.githubusercontent.com/{community-blueprints-repo}/blueprints/trunk/{directory}/{filename.ext}
Example
https://raw.githubusercontent.com/adamziel/blueprints/**trunk**/custom-post/book.php

2. Meta description is not required for all blueprints, only for blueprints to be added to the gallery.

This Blueprints builder could be useful for editing and playing with Blueprints – let's add an "Edit in Builder" link to the gallery:

https://playground.wordpress.net/builder/builder.html

e.g. https://playground.wordpress.net/builder/builder.html#{%22landingPage%22:%22/wp-admin/%22,%22phpExtensionBundles%22:[%22kitchen-sink%22],%22preferredVersions%22:{%22php%22:%227.4%22,%22wp%22:%225.9%22},%22steps%22:[{%22step%22:%22login%22,%22username%22:%22admin%22,%22password%22:%22password%22}]}

Thinking about it more, it would be useful to support a ?blueprint-url= query parameter in that builder.