ci(github): add container support for self-hosted runners by dipankardas011 · Pull Request #9 · rtCamp/plugin-skeleton-d

dipankardas011 · 2026-03-13T07:27:05Z

What

Switch all workflows to use containers on self-hosted runners for improved
consistency and isolation. Add system dependency installation steps and
configure Docker and Git safe directory where needed. Update job dependencies
and permissions for better security and workflow reliability. This enables
better compatibility with shared self-hosted environments.

Switch all workflows to use containers on self-hosted runners for improved consistency and isolation. Add system dependency installation steps and configure Docker and Git safe directory where needed. Update job dependencies and permissions for better security and workflow reliability. This enables better compatibility with shared self-hosted environments. chore(ci): use public-repo runner in all workflows Replace the custom self-hosted runner labels with [public-repo] in all GitHub Actions workflow files. This change standardizes the runner environment and improves compatibility for public repositories. Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com> fix the core volume mount problem Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com> fix(ci): update wp-env test config and add --update flag - Remove "plugins" field from .wp-env.test.json to prevent broken mounts - Add dynamic host mapping for plugin in test config - Add --update flag to npm run wp-env:test start commands for fresh env Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com> ci: improve Docker mapping and plugin activation Update workflows to fix wp-env host mapping, add plugin activation steps, and ensure Docker environments are properly started and stopped. Switch PHPUnit commands to use tests-cli for accurate environment handling. Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

Refactor GitHub Actions workflows to standardize environment variable usage and port assignments for wp-env across build, E2E, and PHPUnit jobs. Removes dynamic COMPOSE_PROJECT_NAME generation and sets static WP_ENV_PORT and WP_ENV_TESTS_PORT values to avoid conflicts on shared self-hosted runners. Updates .wp-env.test.json to include testsPort. Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

Ensure wp-env uses a dedicated /tmp/wp-env directory for all jobs by setting WP_ENV_HOME and mounting it in the container. This prevents permission issues and data conflicts in CI. Updates all workflow steps to use the new environment variable. Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

- Increase `timeout-minutes` for build, e2e, and phpunit workflows to 30 minutes for more reliable CI runs. - Set `timeout_minutes` to 15 for Docker environment startup steps. - Add `git config --global --add safe.directory '/tmp/wp-env/*'` to address Git safe directory issues in Docker. - Run E2E tests with `--debug` for better diagnostics. - No functional changes to plugin code. Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

Update CI workflow to use step outputs for job filtering instead of hardcoded values. This enables more flexible and accurate job execution based on file changes. Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

When running in the Docker-out-of-Docker CI setup, the actions/checkout step creates the workspace files as the `root` user. However, wp-env dynamically configures its internal test containers to run as `wpuser` (UID 1001) to match the host user executing `wp-env start`. This caused a permission collision where the test runner (running as UID 1001) could not write test artifacts (like .phpunit.result.cache and code coverage XML/HTML reports) back to the workspace directory owned by root. This adds a step to `chown -R wpuser:wpuser .` across the build, e2e, and phpunit workflows immediately before starting wp-env. This ensures the containerized test runner has the necessary write privileges to generate and upload coverage reports successfully. Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

Add --add-host=host.docker.internal:host-gateway to container options in the reusable-e2e.yml workflow. Update WP_BASE_URL to use host.docker.internal for E2E tests, enabling proper connectivity between Playwright and the WordPress instance when running in Docker. Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

Use --network=host for the CI container to ensure Playwright shares the host Docker daemon's network. This prevents "ECONNREFUSED" errors when WordPress issues 302 redirects to "localhost", avoiding loopback traps inside the CI container. Also remove WP_BASE_URL env from test command. Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

Switch CI container from --network=host to --add-host and socat proxy for localhost:8889. This ensures Playwright and WordPress agree on "localhost" and prevents network isolation issues. Adds socat to dependencies and updates E2E test step to forward traffic, improving test stability. Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

Set Playwright to run in headless mode by default for more consistent and reliable test execution in CI and local environments. This avoids issues with UI rendering and ensures tests do not require a display server. Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

Removed the --debug flag from the E2E test command in the CI workflow to ensure tests run in standard mode. Updated Playwright config to spread baseConfig.use for better configuration inheritance. These changes improve consistency and maintainability of E2E test execution. Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

Updated CI workflow to use dynamic outputs from filter steps instead of hardcoded values. Enabled e2e job to trigger based on detection results and phpunit status. Removed outdated comments for clarity. Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

.github/workflows/reusable-wp-playground-pr-preview.yml

justlevine

Not sure what here was authored with human intent, so I'm having some trouble reviewing it. Seems the CI is failing too....

.github/workflows/ci.yml

justlevine · 2026-03-19T01:57:23Z

.github/workflows/ci.yml

+    needs: [detect, phpunit]
+    if: needs.detect.result == 'success' && (needs.phpunit.result == 'success' || needs.phpunit.result == 'skipped') && (needs.detect.outputs.php == 'true' || needs.detect.outputs.e2e == 'true' || needs.detect.outputs.js == 'true' || needs.detect.outputs.css == 'true')


Were these changes intentional? Why do we need to wait for phpunit to complete?

wait for phpunit to complete?

we need that becuase we are running on a self-hosted runner having same docker service, which means if 2 services run in parallel then ports can collide! and there are also complications with ensuring the docker compose serviceName and containerName so we need to make it serial execution to avoid complication.

yes fixing the unnecessary deps to streamline it.

What happens if is skipped, will e2e still run or will it be skipped as well?

Looks like it never runs. This made debugging super time wasteful tonight... is there a way to allow it to run after phpunit but regardless of if phpunit's status?

.github/workflows/ci.yml

.github/workflows/reusable-build.yml

.github/workflows/reusable-e2e.yml

.wp-env.test.json

package.json

playwright.config.ts

Copilot

Pull request overview

This PR migrates the repository’s GitHub Actions CI to run inside containers on self-hosted runners, aiming to improve isolation/consistency, while also adjusting wp-env and Playwright behavior to fit the new execution model.

Changes:

Move reusable workflows and the main CI workflow to self-hosted runners with job-level containers, adding system dependency installation and Git safe-directory configuration.
Update wp-env test configuration and CI orchestration (ports, tests environment, mappings) and adjust the PHPUnit npm script to run in the tests container.
Disable Playwright’s automatic webServer orchestration to avoid port conflicts when CI manages wp-env lifecycle externally.

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 17 comments.

Show a summary per file

File	Description
`playwright.config.ts`	Disables Playwright `webServer` orchestration and forces `headless` usage.
`package.json`	Updates PHPUnit command to use `tests-cli` under the wp-env test config.
`.wp-env.test.json`	Enables tests environment and sets a dedicated tests port.
`.github/workflows/reusable-wp-playground-pr-preview.yml`	Runs preview job in a container on self-hosted runner; installs minimal deps; tightens permissions.
`.github/workflows/reusable-phpunit.yml`	Containerizes PHPUnit job; adds Docker/wp-env setup and cleanup; modifies permissions and orchestration.
`.github/workflows/reusable-phpstan.yml`	Containerizes PHPStan job; adds system deps and safe-directory config.
`.github/workflows/reusable-phpcs.yml`	Containerizes PHPCS job; adds system deps and safe-directory config.
`.github/workflows/reusable-lint-css-js.yml`	Containerizes JS/CSS linting using `node:22`; adds safe-directory config.
`.github/workflows/reusable-jest.yml`	Containerizes Jest using `node:22`; adds safe-directory config.
`.github/workflows/reusable-e2e.yml`	Containerizes Playwright E2E job; adds Docker/wp-env setup, Playwright install, socat forwarding, and cleanup.
`.github/workflows/reusable-build.yml`	Containerizes build job; adds Docker/wp-env setup, mapping fixups, and cleanup.
`.github/workflows/ci.yml`	Containerizes detect job, tightens permissions, serializes PHPUnit matrix, and reorders job dependencies (E2E after PHPUnit; build after E2E).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

.github/workflows/reusable-phpcs.yml

.github/workflows/reusable-e2e.yml

.github/workflows/reusable-phpunit.yml

.github/workflows/reusable-lint-css-js.yml

.github/workflows/reusable-jest.yml

.github/workflows/reusable-e2e.yml

playwright.config.ts

.github/workflows/reusable-jest.yml

.github/workflows/reusable-phpunit.yml

- Switch blueprint JSON mutation from Node.js to jq in the workflow, simplifying dependencies and improving readability. - Add jq to system dependencies in the workflow. - Refactor Playwright config to disable webServer orchestration by destructuring base config, preventing port conflicts and aligning with manual wp-env lifecycle management. Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

- Use `ubuntu-latest` instead of custom container in CI workflow - Remove unnecessary system dependency and git safe directory steps - Use `sudo -E -u wpuser` for environment consistency in reusable workflows - Remove explicit port settings from `.wp-env.test.json` - Update `test:php` script to use `cli` instead of `tests-cli` - Improve workflow maintainability and reduce complexity Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

Ensure PATH is preserved when running npm and npx commands as wpuser via sudo in GitHub Actions workflows. This prevents issues where npm, npx, or node may not be found due to a restricted environment PATH. Updates all relevant commands in reusable-build, reusable-e2e, and reusable-phpunit workflows. Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

This reverts commit cafed50.

Ensure npm is available in PATH for the wpuser by updating .bashrc in build, e2e, and phpunit reusable workflows. This helps prevent issues with npm commands not being found during CI runs. Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

.wp-env.test.json

justlevine · 2026-03-19T22:28:42Z

.github/workflows/reusable-phpunit.yml

+      - name: Activate plugin
+        run: |
+          sudo -u wpuser env "PATH=$PATH" "WP_ENV_HOME=$WP_ENV_HOME" npm run wp-env:test run cli -- wp plugin activate plugin-skeleton-d
+          sudo -u wpuser env "PATH=$PATH" "WP_ENV_HOME=$WP_ENV_HOME" npm run wp-env:test run tests-cli -- wp plugin activate plugin-skeleton-d


Is there a reason you added this Activate plugin step? The "mappings" in the *wp-env.test that you removed was intended to keep the plugin disabled, and how the plugin runners currently work.

justlevine · 2026-03-19T23:20:47Z

@dipankardas011 is there a way to cache those install commands? Setting up docker, php, reinstalling npm deps... (not composer, since that's handled by our action)

justlevine · 2026-03-19T23:57:51Z

.github/workflows/reusable-build.yml

      contents: read
+
+    env:
+      WP_ENV_PORT: 8889


I was able to get rid of the (hopefully) unnecessary WP_TESTS_ENV_PORT everywhere when I fixed the .tests.wp-env.json file . I'm pretty sure we can get rid of this one too but the CI is waaay to slow and I ran out of time to try. What do you think?

As a reminder, we're using wp-env 11.1. so there's 1 encironment in a JSON and it defaults to the prt defined in the JSON or the constant

justlevine · 2026-03-20T01:06:57Z

@dipankardas011 I've restored the public gh runners to live alongside these private one, and started on some cleanup regarding the @wordpress/env<11 issues.

I ran out of time to finish testing because of how slow things are, so please review and finish up what else is needed. As you can see both PHPUnit and Playwright E2E tests are passing on the GH runners, so they should all be passing on the private runner side too. 🙇

Edit: and they are 🚀 So just playground and cleanup/optim left.

dipankardas011 marked this pull request as ready for review March 13, 2026 07:27

dipankardas011 force-pushed the ci/self-hosting branch from 3298b6c to 15eae35 Compare March 16, 2026 11:04

dipankardas011 force-pushed the ci/self-hosting branch from 15eae35 to 5e132e8 Compare March 16, 2026 11:09

dipankardas011 added 3 commits March 16, 2026 17:08

fix(ci): add --yes flag to wp-env destroy commands

a3c68ff

Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

fixed the --yes of wp-env destroy with --force

a8a7ab8

Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

dipankardas011 force-pushed the ci/self-hosting branch 2 times, most recently from f8d1bec to 9289434 Compare March 17, 2026 06:37

added a pause for indepth analysis

872e914

Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

dipankardas011 force-pushed the ci/self-hosting branch from 9289434 to 872e914 Compare March 17, 2026 07:09

dipankardas011 added 6 commits March 17, 2026 13:32

disabled spcific section to be able to check the workflow

c5c2ca6

Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

dbg: e2e test suite

ac888b5

Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

dipankardas011 force-pushed the ci/self-hosting branch from 857f1e8 to ac888b5 Compare March 18, 2026 06:54

dipankardas011 added 10 commits March 18, 2026 12:43

test(e2e): path for the npx

681607d

Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

ci(e2e): giving it the wp-env test one

58522b2

Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

ci(e2e): disable Playwright webServer and clean env usage

aa57089

Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

feat(ci): set WP_BASE_URL for E2E tests in workflow

1363a77

Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

dipankardas011 requested a review from justlevine March 18, 2026 14:01

dipankardas011 commented Mar 18, 2026

View reviewed changes

.github/workflows/reusable-wp-playground-pr-preview.yml Outdated Show resolved Hide resolved

Apply suggestion from @dipankardas011

2830f52

justlevine requested changes Mar 19, 2026

View reviewed changes

justlevine requested review from Copilot and mrrobot47 March 19, 2026 02:14

Copilot AI reviewed Mar 19, 2026

View reviewed changes

dipankardas011 and others added 12 commits March 19, 2026 13:09

ci: update workflow dependencies and permissions

08be4c7

Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

ci(playground): add GitHub CLI install to PR preview workflow

752952b

Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

Revert "ci(github): fix PATH for sudo -u wpuser npm commands"

8117a4b

This reverts commit cafed50.

reverted the sudo -E to bring the system back to stability

a244705

Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>

Merge branch 'main' into ci/self-hosting

519a055

ci: restore public workflows

cef424a

ci: Remove unnecessary release-public.yml

ae8ebf8

ci: docs and cleanup

4ba109a

justlevine reviewed Mar 19, 2026

View reviewed changes

.wp-env.test.json Outdated Show resolved Hide resolved

justlevine added 2 commits March 19, 2026 23:37

ci: Fix run id

b33e523

ci: trigger on workflow changes

c2a226f

justlevine reviewed Mar 19, 2026

View reviewed changes

ci: stop using TESTS_PORT (first pass)

3e80ff6

justlevine added 2 commits March 20, 2026 01:28

ci: remove activate plugin step

368222d

Merge branch 'main' into ci/self-hosting

dbd3bcf

justlevine reviewed Mar 19, 2026

View reviewed changes

justlevine added 2 commits March 20, 2026 02:19

ci: more wp-env 11 fixes

116073b

Merge branch 'main' into ci/self-hosting

8bfb2e3

Merge branch 'main' into ci/self-hosting

018ee18

		needs: [detect, phpunit]
		if: needs.detect.result == 'success' && (needs.phpunit.result == 'success' \|\| needs.phpunit.result == 'skipped') && (needs.detect.outputs.php == 'true' \|\| needs.detect.outputs.e2e == 'true' \|\| needs.detect.outputs.js == 'true' \|\| needs.detect.outputs.css == 'true')

Conversation

dipankardas011 commented Mar 13, 2026 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

Uh oh!

Uh oh!

justlevine left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

justlevine Mar 19, 2026

Choose a reason for hiding this comment

Uh oh!

dipankardas011 Mar 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

justlevine Mar 19, 2026

Choose a reason for hiding this comment

Uh oh!

justlevine Mar 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

justlevine Mar 19, 2026

Choose a reason for hiding this comment

Uh oh!

justlevine commented Mar 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

justlevine Mar 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

justlevine commented Mar 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

dipankardas011 commented Mar 13, 2026 •

edited by github-actions bot

Loading

dipankardas011 Mar 19, 2026 •

edited

Loading

justlevine Mar 20, 2026 •

edited

Loading

justlevine commented Mar 19, 2026 •

edited

Loading

justlevine Mar 19, 2026 •

edited

Loading

justlevine commented Mar 20, 2026 •

edited

Loading