Merge pull request #136 from Automattic/standardize/configs-and-ci

GaryJones · web-flow · commit c8144bcb2ef1 · 2025-12-14T02:49:54.000Z
diff --git a/.distignore b/.distignore
@@ -1,20 +1,23 @@
-# Specify which files should not be included in the push to WordPress.org.
-# These are all development files and directories.
-# The deploy Action will use rsync + .distignore if the .distignore exists,
-# so it doesn't care what may or may not be ignored via .gitignore.
-
+# Directories
 /.git/
 /.github/
 /bin/
+/node_modules/
 /tests/
-/.distignore
-/.editorconfig
-/.gitattributes
-/.gitignore
-/.phpcs.xml.dist
-/CHANGELOG.md
-/composer.json
-/mixtape.json
-/package.json
-/package-lock.json
-/phpunit.xml.dist
+/vendor/
+
+# Files
+.distignore
+.editorconfig
+.gitattributes
+.gitignore
+.phpcs.xml.dist
+.wp-env.json
+.wp-env.override.json
+CHANGELOG.md
+composer.json
+composer.lock
+mixtape.json
+package.json
+package-lock.json
+phpunit.xml.dist
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,67 @@
+# Configuration for Dependabot version updates
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+    groups:
+      actions:
+        patterns: ["*"]
+    labels:
+      - "dependencies"
+    reviewers:
+      - "Automattic/vip-plugins"
+    commit-message:
+      prefix: "Actions"
+      include: "scope"
+    open-pull-requests-limit: 5
+
+  - package-ecosystem: "composer"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "tuesday"
+    groups:
+      dev-dependencies:
+        patterns:
+          - "automattic/*"
+          - "dealerdirect/*"
+          - "php-parallel-lint/*"
+          - "phpcompatibility/*"
+          - "phpunit/*"
+          - "squizlabs/*"
+          - "yoast/*"
+    labels:
+      - "dependencies"
+    reviewers:
+      - "Automattic/vip-plugins"
+    commit-message:
+      prefix: "Composer"
+      include: "scope"
+    open-pull-requests-limit: 5
+    versioning-strategy: increase-if-necessary
+
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "wednesday"
+    groups:
+      dev-dependencies:
+        patterns:
+          - "@wordpress/*"
+          - "eslint*"
+          - "prettier*"
+          - "@types/*"
+    labels:
+      - "dependencies"
+    reviewers:
+      - "Automattic/vip-plugins"
+    commit-message:
+      prefix: "npm"
+      include: "scope"
+    open-pull-requests-limit: 5
diff --git a/.github/workflows/cs-lint.yml b/.github/workflows/cs-lint.yml
@@ -10,6 +10,8 @@ on:
   # Allow manually triggering the workflow.
   workflow_dispatch:
 
+permissions: {}
+
 jobs:
   check_cs:
     name: "Basic CS and QA checks"
@@ -20,7 +22,7 @@ jobs:
 
     steps:
       - name: Setup PHP
-        uses: shivammathur/setup-php@v2
+        uses: shivammathur/setup-php@44454db4f0199b8b9685a5d763dc37cbf79108e1 # 2.36.0
         with:
           php-version: "8.3"
           coverage: none
@@ -29,15 +31,17 @@ jobs:
       # Show PHP lint violations inline in the file diff.
       # @link https://github.com/marketplace/actions/xmllint-problem-matcher
       - name: Register PHP lint violations to appear as file diff comments
-        uses: korelstar/phplint-problem-matcher@v1
+        uses: korelstar/phplint-problem-matcher@cb2b753750ec7bf13a7cde0a476df8c5605bdfb1 # v1.2.0
 
       # Show XML violations inline in the file diff.
       # @link https://github.com/marketplace/actions/xmllint-problem-matcher
       - name: Register XML violations to appear as file diff comments
-        uses: korelstar/xmllint-problem-matcher@v1
+        uses: korelstar/xmllint-problem-matcher@1bd292d642ddf3d369d02aaa8b262834d61198c0 # v1.2.0
 
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+        with:
+          persist-credentials: false
 
       # Validate the composer.json file.
       # @link https://getcomposer.org/doc/03-cli.md#validate
@@ -47,7 +51,7 @@ jobs:
       # Install dependencies and handle caching in one go.
       # @link https://github.com/marketplace/actions/install-composer-dependencies
       - name: Install Composer dependencies
-        uses: ramsey/composer-install@v3
+        uses: ramsey/composer-install@3cf229dc2919194e9e36783941438d17239e8520 # 3.1.1
 
       # Lint PHP.
       - name: Lint PHP against parse errors
@@ -56,7 +60,7 @@ jobs:
       # Needed as runs-on: system doesn't have xml-lint by default.
       # @link https://github.com/marketplace/actions/xml-lint
       - name: Lint phpunit.xml.dist
-        uses: ChristophWurst/xmllint-action@v1
+        uses: ChristophWurst/xmllint-action@7c54ff113fc0f6d4588a15cb4dfe31b6ecca5212 # v1.2.1
         with:
           xml-file: ./phpunit.xml.dist
           xml-schema-file: ./vendor/phpunit/phpunit/phpunit.xsd
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -4,21 +4,26 @@ on:
     types: [ released ]
   # Allow manual triggering of the workflow.
   workflow_dispatch:
+
+permissions: {}
+
 jobs:
   release:
     name: New release to WordPress.org
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+        with:
+          persist-credentials: false
 
       - name: Install SVN (Subversion)
         run: |
           sudo apt-get update
           sudo apt-get install subversion
 
       - name: Push to WordPress.org
-        uses: 10up/action-wordpress-plugin-deploy@stable
+        uses: 10up/action-wordpress-plugin-deploy@54bd289b8525fd23a5c365ec369185f2966529c2 # stable
         env:
           SLUG: zoninator
           SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}
diff --git a/.github/workflows/integration.yml b/.github/workflows/integration.yml
@@ -6,6 +6,8 @@ on:
     paths-ignore:
       - "**.md"
 
+permissions: {}
+
 jobs:
   test:
     name: WP ${{ matrix.wordpress }} on PHP ${{ matrix.php }}
@@ -39,35 +41,41 @@ jobs:
     steps:
 
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+        with:
+          persist-credentials: false
 
       - name: Install wordpress environment
         run: npm install -g @wordpress/env
 
       - name: Setup PHP ${{ matrix.php }}
-        uses: shivammathur/setup-php@v2
+        uses: shivammathur/setup-php@44454db4f0199b8b9685a5d763dc37cbf79108e1 # 2.36.0
         with:
           php-version: ${{ matrix.php }}
           tools: composer
 
       - name: Install Composer dependencies
-        uses: ramsey/composer-install@v3
+        uses: ramsey/composer-install@3cf229dc2919194e9e36783941438d17239e8520 # 3.1.1
         with:
           composer-options: "${{ matrix.composer-options }}"
 
       - name: Setup problem matchers for PHP
-        run: echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+        run: echo "::add-matcher::${RUNNER_TOOL_CACHE}/php.json"
+        env:
+          RUNNER_TOOL_CACHE: ${{ runner.tool_cache }}
 
       - name: Setup Problem Matchers for PHPUnit
-        run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
+        run: echo "::add-matcher::${RUNNER_TOOL_CACHE}/phpunit.json"
+        env:
+          RUNNER_TOOL_CACHE: ${{ runner.tool_cache }}
 
       - name: Setup wp-env
         run: wp-env start
         env:
           WP_ENV_CORE: WordPress/WordPress#${{ matrix.wordpress }}
 
       - name: Run integration tests (single site)
-        run: composer test-integration
+        run: composer test:integration
 
       - name: Run integration tests (multisite)
-        run: composer test-integration-ms
+        run: composer test:integration-ms
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,15 @@
-/.phpunit.cache/
+# Dependencies
 /node_modules/
 /vendor/
-/.phpcs.xml
+
+# Composer
 /composer.lock
+
+# Tests
+/.phpunit.cache/
+
+# Local config overrides
+/.phpcs.xml
 /phpcs.xml
 /phpunit.xml
+/.wp-env.override.json
diff --git a/composer.json b/composer.json
@@ -24,7 +24,7 @@
 		"phpcompatibility/phpcompatibility-wp": "^2.1",
 		"phpunit/phpunit": "^9",
 		"rector/rector": "^1.2",
-		"yoast/phpunit-polyfills": "^1"
+		"yoast/wp-test-utils": "^1.2"
 	},
 	"config": {
 		"allow-plugins": {
@@ -55,8 +55,8 @@
 		"lint-ci": [
 			"@php ./vendor/php-parallel-lint/php-parallel-lint/parallel-lint . -e php --exclude vendor --exclude .git --checkstyle"
 		],
-		"test-integration": "wp-env run tests-cli --env-cwd=wp-content/plugins/zoninator ./vendor/bin/phpunit --testsuite WP_Tests",
-		"test-integration-ms": "wp-env run tests-cli --env-cwd=wp-content/plugins/zoninator /bin/bash -c 'WP_MULTISITE=1 ./vendor/bin/phpunit --testsuite WP_Tests'"
+		"test:integration": "wp-env run tests-cli --env-cwd=wp-content/plugins/zoninator ./vendor/bin/phpunit --testsuite WP_Tests",
+		"test:integration-ms": "wp-env run tests-cli --env-cwd=wp-content/plugins/zoninator /bin/bash -c 'WP_MULTISITE=1 ./vendor/bin/phpunit --testsuite WP_Tests'"
 	},
 	"scripts-descriptions": {
 		"coverage": "Run tests with code coverage reporting",
@@ -66,7 +66,7 @@
 		"i18n": "Generate a POT file for translation",
 		"lint": "Run PHP linting",
 		"lint-ci": "Run PHP linting and send results to stdout",
-		"test-integration": "Run all integration tests for the Zoninator plugin",
-		"test-integration-ms": "Run integration tests for the Zoninator plugin in multisite mode"
+		"test:integration": "Run integration tests",
+		"test:integration-ms": "Run integration tests in multisite mode"
 	}
 }
