Skip to content

build: pin the wp-env WordPress core and plugin versions #636

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.

Sign up for GitHub

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

Draft
jkmassel wants to merge 1 commit into
base: trunk
Choose a base branch
from
Draft

build: pin the wp-env WordPress core and plugin versions #636

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .wp-env.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"core": "https://wordpress.org/latest.zip",
"core": "https://wordpress.org/wordpress-7.1.zip",
"plugins": [
"https://downloads.wordpress.org/plugin/gutenberg.zip",
"https://downloads.wordpress.org/plugin/jetpack.zip"
"https://downloads.wordpress.org/plugin/gutenberg.23.9.1.zip",
"https://downloads.wordpress.org/plugin/jetpack.16.1.3.zip"
],
"mappings": {
"wp-content/mu-plugins": "./wp-env/mu-plugins"
Expand Down
24 changes: 24 additions & 0 deletions docs/code/local-wordpress.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,30 @@ The `.wp-env.json` file at the project root configures the environment:
- A **CORS mu-plugin** (`wp-env/mu-plugins/gutenbergkit-cors.php`) adds CORS headers to REST API responses, allowing requests from the Vite dev server, preview server, and native WebViews.
- **WP_DEBUG** and **WP_DEBUG_LOG** are enabled for development.

WordPress core and both plugins are **pinned to explicit versions**. wp-env
downloads whatever the URL resolves to, so unpinned URLs mean every CI run
installs whatever shipped that day — and a third-party release can turn every
open PR red without a line of code changing. That has happened: a Jetpack
release began requiring `window.wp.theme`, and until #614 exposed it, no
Jetpack block registered and the third-party block E2E tests failed on every
branch that predated the fix.

Pinning trades that for a manual bump. Nothing watches these versions —
Dependabot does not read `.wp-env.json` — so raise them deliberately, in their
own PR, where a failure is attributable to the upgrade rather than to whatever
else is in flight:

```json
"core": "https://wordpress.org/wordpress-<version>.zip",
"plugins": [
"https://downloads.wordpress.org/plugin/gutenberg.<version>.zip",
"https://downloads.wordpress.org/plugin/jetpack.<version>.zip"
]
```

Bumping requires `make wp-env-start RESET=1`, since an existing environment
keeps the version it was created with.

### Credential Provisioning

The `bin/wp-env-setup.sh` script runs automatically after `wp-env start`:
Expand Down
Loading