Example plugin: Update build/test/release workflow, dependencies; Remove wp-now to be replaced by WP Playground CLI

Author: eliot-akira

.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+name: Publish NPM package
+permissions:
+  contents: write
+on:
+  workflow_run:
+    workflows: ["Run Tests"]
+    tags:
+      - '*'
+    types:
+      - completed
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    # Require tests to pass before publish
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v2
+      - name: Install dependencies
+        run: bun install
+      - name: Build NPM package
+        run: bun run build:npm
+      # - name: Publish NPM package
+      #   run: |
+      #     cd publish/npm
+      #     bun publish --access public
+      #   env:
+      #     NPM_CONFIG_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/release.yml

@@ -1,10 +1,18 @@
 name: Release
 permissions:
   contents: write
-on: push
+on:
+  workflow_run:
+    workflows: ["Run Tests"]
+    branches: [main]
+    types:
+      - completed
 jobs:
   build:
     runs-on: ubuntu-latest
+    # Require tests to pass before release
+    # https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#running-a-workflow-based-on-the-conclusion-of-another-workflow
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4

.github/workflows/tests.yml

@@ -0,0 +1,41 @@
+name: Run Tests
+permissions:
+  contents: write
+on:
+  push:
+  workflow_call: # Allow this workflow to be called from other workflows
+jobs:
+  tests:
+    timeout-minutes: 15
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Docker
+        uses: docker/setup-docker-action@v4
+      - name: Set up PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.2'
+          tools: phpunit-polyfills
+      # Configure workspace as safe for Git, to solve: https://github.com/composer/composer/issues/12221
+      - name: Git safe.directory
+        run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
+      - name: Install Composer dependencies
+        run: composer install --no-interaction --no-progress --optimize-autoloader
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v2
+      - name: Install dependencies
+        run: bun install
+      - name: PHPUnit - Run tests for PHP 7.4
+        run: bun run test:7.4
+      - name: PHPUnit - Run tests for PHP 8.2
+        run: bun run test:8.2
+      - name: Jest - Run tests
+        run: bun run jest:test
+      - name: Install playwright
+        run: bun playwright install
+      - name: End to end - Run tests
+        run: bun run e2e

.wp-env.json

@@ -2,6 +2,11 @@
   "core": "WordPress/WordPress",
   "phpVersion": "8.2",
   "plugins": ["."],
+  "config": {
+    "WP_DEBUG": true,
+    "WP_DEBUG_LOG": true,
+    "WP_DEBUG_DISPLAY": false
+  },
   "mappings": {
   }
 }

bitbucket-pipelines.yml

@@ -3,15 +3,15 @@
  * Plugin Name: Example Plugin
  * Plugin URI: https://tangibleplugins.com/example-plugin
  * Description: Description of example plugin
- * Version: 0.1.1
+ * Version: 0.0.1
  * Author: Team Tangible
  * Author URI: https://teamtangible.com
  * License: GPLv2 or later
  */
 use tangible\framework;
 use tangible\updater;
 
-define( 'EXAMPLE_PLUGIN_VERSION', '0.1.1' );
+define( 'EXAMPLE_PLUGIN_VERSION', '0.0.1' );
 
 require __DIR__ . '/vendor/tangible/framework/index.php';
 require __DIR__ . '/vendor/tangible/updater/index.php';

blueprint.dev.json

@@ -1,7 +1,7 @@
 {
   "name": "example-plugin",
   "description": "Description of example plugin",
-  "version": "0.1.1",
+  "version": "0.0.1",
   "type": "module",
   "homepage": "https://github.com/tangibleinc/example-plugin",
   "repository": {
@@ -19,16 +19,15 @@
     "update": "roll update",
     "install:dev": "roll install --dev",
     "update:dev": "roll update --dev",
-    "archive": "roll archive -y && rm -rf publish/example-plugin && unzip -q publish/example-plugin.zip -d publish/ && npm run now:test:archive",
-    "now": "wp-now start --blueprint=blueprint.dev.json",
-    "now:dev": "concurrently --raw 'roll dev' 'npm run now'",
-    "now:test": "roll run tests/now/index.ts",
-    "now:test:archive": "roll run tests/now/index.ts TEST_ARCHIVE=1",
+    "archive": "roll archive -y",
     "-- Local environment --": "https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env",
     "env": "wp-env",
     "composer": "FOLDER=`basename $(realpath $PWD)`; wp-env run cli --env-cwd=wp-content/plugins/$FOLDER composer",
     "composer:install": "wp-env run cli sudo apk add git && npm run composer install",
     "composer:update": "npm run composer update",
+    "log": "wp-env run cli cat wp-content/debug.log",
+    "shell": "wp-env run cli bash",
+    "wp": "wp-env run cli wp",
     "test": "FOLDER=`basename $(realpath $PWD)`; wp-env run tests-wordpress /var/www/html/wp-content/plugins/$FOLDER/vendor/bin/phpunit --testdox -c /var/www/html/wp-content/plugins/$FOLDER/phpunit.xml --verbose",
     "test:7.4": "WP_ENV_PHP_VERSION=7.4 wp-env start && npm run test",
     "test:8.2": "WP_ENV_PHP_VERSION=8.2 wp-env start && npm run test",
@@ -44,13 +43,12 @@
   },
   "dependencies": {},
   "devDependencies": {
-    "@playwright/test": "^1.52.0",
-    "@tangible/now": "^3.0.2",
-    "@tangible/roller": "^2.1.4",
-    "@wordpress/e2e-test-utils-playwright": "^1.22.0",
-    "@wordpress/env": "^10.22.0",
+    "@playwright/test": "^1.56.1",
+    "@tangible/roller": "^2.1.7",
+    "@wordpress/e2e-test-utils-playwright": "^1.33.0",
+    "@wordpress/env": "^10.33.0",
     "chokidar-cli": "^3.0.0",
-    "concurrently": "^9.1.2",
+    "concurrently": "^9.2.1",
     "testra": "^2.1.5"
   },
   "author": "Team Tangible",

example-plugin.php

@@ -38,13 +38,13 @@ npm run format
 
 ### Local dev site
 
-Start a local dev site using [`wp-now`](https://github.com/WordPress/playground-tools/blob/trunk/packages/wp-now/README.md).
+Start a local dev site using [`wp-env`](https://github.com/WordPress/playground-tools/blob/trunk/packages/wp-now/README.md).
 
 ```sh
-npm run now
+npm run start
 ```
 
-The default user is `admin` with `password`. Press CTRL + C to stop.
+For details see [Tests](#tests) below.
 
 #### Dev dependencies
 
@@ -86,7 +86,7 @@ npm run start
 
 This uses [`wp-env`](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/) to quickly spin up a local dev and test environment, optionally switching between multiple PHP versions. It requires **Docker** to be installed. There are instructions available for installing Docker on [Windows](https://docs.docker.com/desktop/install/windows-install/), [macOS](https://docs.docker.com/desktop/install/mac-install/), and [Linux](https://docs.docker.com/desktop/install/linux-install/).
 
-Visit [http://localhost:8888](http://localhost:8888) to see the dev site, and [http://localhost:8889](http://localhost:8880) for the test site, whose database is cleared on every run.
+Visit [http://localhost:8888](http://localhost:8888) to see the dev site (default user `admin` with `password`); and [http://localhost:8889](http://localhost:8880) for the test site, whose database is cleared on every run.
 
 Before running tests, install PHPUnit as a dev dependency using Composer inside the container.