release: merge Release 1.4.0 into main for production release

.distignore

@@ -8,6 +8,7 @@ tests/
 phpunit.xml.dist
 wp-tests-config-sample.php
 phpcs.xml.dist
+phpstan.dist.neon
 composer.json
 composer.lock
 package.json

.github/workflows/coding-standards.yml

@@ -5,7 +5,6 @@ on:
     branches:
       - main
   pull_request:
-
   workflow_dispatch:
 
 # Cancels all previous workflow runs for pull requests that have not completed.
@@ -20,44 +19,27 @@ concurrency:
 permissions: {}
 
 jobs:
-  # Runs the PHP coding standards checks.
-  #
-  # Violations are reported inline with annotations.
-  #
-  # Performs the following steps:
-  # - Checks out the repository.
-  # - Sets up PHP.
-  # - Installs Composer dependencies.
-  # - Make Composer packages available globally.
-  # - Runs PHPCS on the full codebase (warnings excluded).
-  # - Ensures version-controlled files are not modified or deleted.
-  phpcs:
+  lint:
     name: Run coding standards checks
     runs-on: ubuntu-latest
     permissions:
       contents: read
-    timeout-minutes: 20
 
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup cache
+        uses: actions/cache@v5
         with:
-          show-progress: ${{ runner.debug == '1' && 'true' || 'false' }}
+          key: ${{ runner.os }}-${{ hashFiles('composer.json') }} # Note that lock file will change between runs.
+          path: .cache
 
       - name: Set up PHP
         uses: shivammathur/setup-php@cf4cade2721270509d5b1c766ab3549210a39a2a # v2.33.0
-        with:
-          coverage: none
-
-      - name: Install Composer dependencies
-        uses: ramsey/composer-install@3cf229dc2919194e9e36783941438d17239e8520 # v3.1.1
-
-      - name: Make Composer packages available globally
-        run: echo "${PWD}/vendor/bin" >> $GITHUB_PATH
 
-      - name: Run PHPCS on all files
-        id: phpcs-files
-        run: phpcs . -n --report-full
+      - name: Install dependencies
+        run: composer install
 
-      - name: Ensure version-controlled files are not modified during the checks
-        run: git diff --exit-code
+      - name: Lint PHP
+        run: composer run lint

.github/workflows/phpunit-tests.yml

@@ -96,7 +96,7 @@ jobs:
           COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Install Composer dependencies
-        run: composer install --optimize-autoloader --prefer-dist
+        run: composer update --optimize-autoloader --prefer-dist
 
       - name: Install SVN
         run: sudo apt-get update && sudo apt-get install -y subversion
@@ -113,6 +113,3 @@ jobs:
         run: |
           echo "define('WP_TESTS_PHPUNIT_POLYFILLS_PATH', '$HOME/.composer/vendor/yoast/phpunit-polyfills');" >> ${{ runner.temp }}/wordpress-tests-lib/wp-tests-config.php
           phpunit
-
-      - name: Ensure version-controlled files are not modified or deleted
-        run: git diff --exit-code

.github/workflows/publish-fair.yml

@@ -0,0 +1,45 @@
+name: Publish FAIR Metadata
+
+on:
+  workflow_run:
+    workflows: ["Upload Release Asset"]
+    types: [completed]
+  workflow_dispatch:
+    inputs:
+      version:
+        description: Version tag (for example v1.2.3)
+        required: false
+        type: string
+
+permissions:
+  contents: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    if: ${{ github.event_name == 'workflow_dispatch' || github.event.workflow_run.conclusion == 'success' }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Get tag
+        id: tag
+        run: |
+          if [[ "${{ github.event_name }}" == "workflow_dispatch" && -n "${{ inputs.version }}" ]]; then
+            echo "tag=${{ inputs.version }}" >> $GITHUB_OUTPUT
+          else
+            echo "tag=${{ github.event.workflow_run.head_branch }}" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Publish to FAIR
+        uses: fairpm/fair-pulse@v1
+        with:
+          version: ${{ steps.tag.outputs.tag }}
+          artifact-name: ${{ github.event.repository.name }}-${{ steps.tag.outputs.tag }}.zip
+          upload-metadata: 'true'
+        env:
+          FAIR_VERIFICATION_KEY_PRIVATE: ${{ secrets.FAIR_VERIFICATION_KEY_PRIVATE }}
+          FAIR_VERIFICATION_KEY_PUBLIC: ${{ secrets.FAIR_VERIFICATION_KEY_PUBLIC }}
+          FAIR_DID: ${{ vars.FAIR_DID }}

.github/workflows/releases.yml

@@ -17,12 +17,26 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@master
 
+      - name: Set up PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.2'
+          tools: composer
+
+      - name: Install Composer dependencies
+        run: composer install --no-dev --optimize-autoloader --no-interaction
+
       - name: Get tag
         id: tag
         run: echo "tag=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
 
       - name: Build project
-        run: git archive -o /tmp/${{ github.event.repository.name }}-${{ steps.tag.outputs.tag }}.zip --prefix=${{ github.event.repository.name }}/ ${{ steps.tag.outputs.tag }}
+        run: |
+          git archive -o /tmp/${{ github.event.repository.name }}-${{ steps.tag.outputs.tag }}.zip --prefix=${{ github.event.repository.name }}/ ${{ steps.tag.outputs.tag }}
+          mkdir -p /tmp/vendor-stage/${{ github.event.repository.name }}
+          cp -r vendor /tmp/vendor-stage/${{ github.event.repository.name }}/vendor
+          cd /tmp/vendor-stage
+          zip -r /tmp/${{ github.event.repository.name }}-${{ steps.tag.outputs.tag }}.zip ${{ github.event.repository.name }}/vendor/
 
       - name: Create WP distribution files
         run: bin/bundle.sh

.gitignore

@@ -3,12 +3,15 @@
 *.bak
 /.vscode
 /vendor/
+.wp-env.override.json
 .phpunit.result.cache
 phpunit.xml
 phpcs.xml
+phpstan.neon
 /tests/phpunit/cache
 /tests/phpunit/coverage
 wp-tests-config.php
+*.swp
 
 # Track placeholders so that empty directories stay in the repo.
 !.gitkeep

CONTRIBUTING.md

@@ -18,18 +18,29 @@ $ git commit -s -m 'My commit message.'
 
 This plugin is ready to use with wp-env for local development, with a default configuration included in the repository. `npm run env` is an alias for `wp-env`:
 
-```sh
-# Install wp-env and other dependencies.
-$ npm install
+- `npm install` to install wp-env and other dependencies.
+- `npm run env start` to start the development server. Run `npm run env start -- --xdebug=coverage` to enable Xdebug with test coverage reporting.
+- `npm run env logs` to get the logs.
+- `npm run env stop` to stop the development server.
+- `npm run cli` to run any CLI commands inside the environment, such as `npm run cli -- wp plugin list`.
 
-# Start the development server
-$ npm run env start
+By default wp-env is configured with PHP 7.4 (our minimum supported version), as well as Airplane Mode to avoid inadvertent requests.
 
-# Get the logs
-$ npm run env logs
+For linting and static analysis:
 
-# Stop the development server
-$ npm run env stop
-```
+- `npm run lint:php:phpcs` to run PHPCS (configured in [`phpcs.xml.dist`](phpcs.xml.dist)).
+- `npm run lint:php:phpstan` to run PHPStan (configured in [`phpstan.dist.neon`](phpstan.dist.neon)).
+- `npm run format:php:phpcs` to automatically fix PHPCS issues.
+- `npm run format:php:phpstan` to automatically fix PHPStan issues.
+- `npm run cli -- composer phpstan-baseline` to update the PHPStan baseline [`tests/phpstan-baseline.neon`](tests/phpstan-baseline.neon) as you fix the reported issues.
+
+### Configuring PHP and WP Versions
 
-By default, wp-env is configured with PHP 7.4 (our minimum supported version), as well as Airplane Mode to avoid inadvertent requests.
+To run a specific version of PHP or WP with your local development environment, create a `.wp-env.override.json` file in the root of the repository with the following contents:
+
+```json
+{
+	"phpVersion": "8.5",
+	"core": "https://wordpress.org/wordpress-6.9.zip"
+}
+```