CI/CD (GitHub Actions)

Automating your tests is the key to maintaining a stable plugin. Copy this .yml file into your .github/workflows/plugwright.yml to get instant automated tests for every PR.

name: Plugwright E2E Tests

on:
  push:
    branches: [ "main" ]
  pull_request:
    branches: [ "main" ]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: drownek/plugwright-action@v1
        with:
          java-version: "17"
          node-version: "24"
          # Path to your plugin gradle project if it's not at the project's root
          working-directory: "."

Private npm registries

If the test workspace installs from a private registry, declare it once in build.gradle.kts and pass the token through the environment. Nothing about the registry has to be configured on the runner, and the workflow file holds a secret name rather than a secret:

plugwright {
    npm {
        registry("https://nexus.corp/repository/npm-group/") {
            authToken(secret.env("NPM_TOKEN"))
        }
    }
}

      - uses: drownek/plugwright-action@v1
        env:
          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
        with:
          java-version: "17"
          node-version: "24"

Plugwright generates the .npmrc from that block before each npm install. If NPM_TOKEN is missing from the job, the build stops and names it, instead of failing later with a 404 that looks like a typo in a package name. See Configuration. The generated file is gitignored, but it does exist on disk for the length of the job. On a self-hosted runner with a shared workspace, clean it up the way you would any other credential the job writes.

Get Started

Documentation

Environments

Maintaining

CI/CD (GitHub Actions)

Private npm registries

​Private npm registries

Private npm registries