Add Hello Dolly and WP_DEBUG to WordPress Playground, update documentation and fix GitHub Actions
This commit is contained in:
6
.github/workflows/playground-tests.yml
vendored
6
.github/workflows/playground-tests.yml
vendored
@@ -12,7 +12,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
node-version: [18, 20]
|
node-version: [18.18, 20]
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
@@ -66,11 +66,11 @@ jobs:
|
|||||||
run: |
|
run: |
|
||||||
# Start WordPress Playground with our blueprint
|
# Start WordPress Playground with our blueprint
|
||||||
wp-playground start --blueprint playground/blueprint.json --port 8888 &
|
wp-playground start --blueprint playground/blueprint.json --port 8888 &
|
||||||
|
|
||||||
# Wait for WordPress Playground to be ready
|
# Wait for WordPress Playground to be ready
|
||||||
echo "Waiting for WordPress Playground to be ready..."
|
echo "Waiting for WordPress Playground to be ready..."
|
||||||
timeout 60 bash -c 'until curl -s http://localhost:8888; do sleep 2; done'
|
timeout 60 bash -c 'until curl -s http://localhost:8888; do sleep 2; done'
|
||||||
|
|
||||||
# Run Cypress tests against WordPress Playground
|
# Run Cypress tests against WordPress Playground
|
||||||
npm run test:single:headless
|
npm run test:single:headless
|
||||||
|
|
||||||
|
|||||||
2
.github/workflows/wordpress-tests.yml
vendored
2
.github/workflows/wordpress-tests.yml
vendored
@@ -12,7 +12,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
node-version: [18, 20]
|
node-version: [18.18, 20]
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
|
|||||||
@@ -15,11 +15,11 @@ This document explains how to use WordPress Playground for testing our plugin.
|
|||||||
|
|
||||||
The easiest way to test our plugin with WordPress Playground is to use the online version:
|
The easiest way to test our plugin with WordPress Playground is to use the online version:
|
||||||
|
|
||||||
1. Single site testing: [Open in WordPress Playground](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/feature/testing-framework/playground/blueprint.json&_t=5)
|
1. Single site testing: [Open in WordPress Playground](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/feature/testing-framework/playground/blueprint.json&_t=6)
|
||||||
|
|
||||||
2. Multisite testing: [Open in WordPress Playground](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/feature/testing-framework/playground/multisite-blueprint.json&_t=18)
|
2. Multisite testing: [Open in WordPress Playground](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/feature/testing-framework/playground/multisite-blueprint.json&_t=19)
|
||||||
|
|
||||||
These links will automatically set up WordPress with multisite enabled and the Plugin Toggle plugin network-activated.
|
These links will automatically set up WordPress with multisite enabled, WP_DEBUG enabled, and both the Plugin Toggle and Hello Dolly plugins activated.
|
||||||
|
|
||||||
## WP-CLI Commands for WordPress Playground
|
## WP-CLI Commands for WordPress Playground
|
||||||
|
|
||||||
@@ -111,8 +111,8 @@ We have two blueprints for testing:
|
|||||||
To run tests with WordPress Playground:
|
To run tests with WordPress Playground:
|
||||||
|
|
||||||
1. Open the appropriate WordPress Playground link:
|
1. Open the appropriate WordPress Playground link:
|
||||||
- [Single site](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/feature/testing-framework/playground/blueprint.json&_t=5)
|
- [Single site](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/feature/testing-framework/playground/blueprint.json&_t=6)
|
||||||
- [Multisite](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/feature/testing-framework/playground/multisite-blueprint.json&_t=18)
|
- [Multisite](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/feature/testing-framework/playground/multisite-blueprint.json&_t=19)
|
||||||
|
|
||||||
2. Test the plugin manually in the browser
|
2. Test the plugin manually in the browser
|
||||||
|
|
||||||
@@ -130,8 +130,32 @@ You can serve these files locally with a simple HTTP server:
|
|||||||
python -m http.server 8888 --directory playground
|
python -m http.server 8888 --directory playground
|
||||||
|
|
||||||
# Then open http://localhost:8888/index.html in your browser
|
# Then open http://localhost:8888/index.html in your browser
|
||||||
|
# Or open http://localhost:8888/multisite.html for multisite testing
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Using wp-now
|
||||||
|
|
||||||
|
Alternatively, you can use [wp-now](https://github.com/WordPress/playground-tools/tree/trunk/packages/wp-now), a tool from the WordPress Playground team that makes it easy to run WordPress locally:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Install wp-now globally
|
||||||
|
npm install -g @wp-playground/wp-now
|
||||||
|
|
||||||
|
# Start a WordPress instance with the current plugin
|
||||||
|
wp-now start
|
||||||
|
|
||||||
|
# Start with multisite enabled
|
||||||
|
wp-now start --multisite
|
||||||
|
|
||||||
|
# Start with specific PHP and WordPress versions
|
||||||
|
wp-now start --php 8.0 --wp 6.2
|
||||||
|
|
||||||
|
# Start with WP_DEBUG enabled
|
||||||
|
wp-now start --wp-debug
|
||||||
|
```
|
||||||
|
|
||||||
|
This will start a local WordPress instance with your plugin installed and activated.
|
||||||
|
|
||||||
## Customizing Blueprints
|
## Customizing Blueprints
|
||||||
|
|
||||||
You can customize the blueprints to suit your testing needs. See the [WordPress Playground Blueprints documentation](https://wordpress.github.io/wordpress-playground/blueprints/) for more information.
|
You can customize the blueprints to suit your testing needs. See the [WordPress Playground Blueprints documentation](https://wordpress.github.io/wordpress-playground/blueprints/) for more information.
|
||||||
|
|||||||
@@ -104,11 +104,11 @@ WordPress Playground runs WordPress entirely in the browser using WebAssembly. T
|
|||||||
|
|
||||||
The easiest way to test our plugin with WordPress Playground is to use the online version:
|
The easiest way to test our plugin with WordPress Playground is to use the online version:
|
||||||
|
|
||||||
1. Single site testing: [Open in WordPress Playground](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/feature/testing-framework/playground/blueprint.json&_t=5)
|
1. Single site testing: [Open in WordPress Playground](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/feature/testing-framework/playground/blueprint.json&_t=6)
|
||||||
|
|
||||||
2. Multisite testing: [Open in WordPress Playground](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/feature/testing-framework/playground/multisite-blueprint.json&_t=18)
|
2. Multisite testing: [Open in WordPress Playground](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/feature/testing-framework/playground/multisite-blueprint.json&_t=19)
|
||||||
|
|
||||||
These links will automatically set up WordPress with multisite enabled and the Plugin Toggle plugin network-activated.
|
These links will automatically set up WordPress with multisite enabled, WP_DEBUG enabled, and both the Plugin Toggle and Hello Dolly plugins activated.
|
||||||
|
|
||||||
#### Local Testing with HTML Files
|
#### Local Testing with HTML Files
|
||||||
|
|
||||||
|
|||||||
2023
package-lock.json
generated
2023
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@@ -3,12 +3,22 @@
|
|||||||
"landingPage": "/wp-admin/",
|
"landingPage": "/wp-admin/",
|
||||||
"login": true,
|
"login": true,
|
||||||
"steps": [
|
"steps": [
|
||||||
|
{
|
||||||
|
"step": "defineWpConfigConsts",
|
||||||
|
"consts": {
|
||||||
|
"WP_DEBUG": true
|
||||||
|
}
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"step": "installPlugin",
|
"step": "installPlugin",
|
||||||
"pluginData": {
|
"pluginData": {
|
||||||
"resource": "wordpress.org/plugins",
|
"resource": "wordpress.org/plugins",
|
||||||
"slug": "plugin-toggle"
|
"slug": "plugin-toggle"
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"step": "wp-cli",
|
||||||
|
"command": "wp plugin activate hello-dolly"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -20,6 +20,6 @@
|
|||||||
</style>
|
</style>
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<iframe src="https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/feature/testing-framework/playground/blueprint.json&_t=5"></iframe>
|
<iframe src="https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/feature/testing-framework/playground/blueprint.json&_t=6"></iframe>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|||||||
@@ -6,6 +6,12 @@
|
|||||||
"networking": true
|
"networking": true
|
||||||
},
|
},
|
||||||
"steps": [
|
"steps": [
|
||||||
|
{
|
||||||
|
"step": "defineWpConfigConsts",
|
||||||
|
"consts": {
|
||||||
|
"WP_DEBUG": true
|
||||||
|
}
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"step": "enableMultisite"
|
"step": "enableMultisite"
|
||||||
},
|
},
|
||||||
@@ -16,6 +22,10 @@
|
|||||||
{
|
{
|
||||||
"step": "wp-cli",
|
"step": "wp-cli",
|
||||||
"command": "wp plugin install plugin-toggle --activate-network"
|
"command": "wp plugin install plugin-toggle --activate-network"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"step": "wp-cli",
|
||||||
|
"command": "wp plugin activate hello-dolly --network"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -20,6 +20,6 @@
|
|||||||
</style>
|
</style>
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<iframe src="https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/feature/testing-framework/playground/multisite-blueprint.json&_t=18"></iframe>
|
<iframe src="https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/wpallstars/wp-plugin-starter-template-for-ai-coding/feature/testing-framework/playground/multisite-blueprint.json&_t=19"></iframe>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|||||||
Reference in New Issue
Block a user