diff --git a/.claude/skills/playwright-triage/SKILL.md b/.claude/skills/playwright-triage/SKILL.md index 08f4834f0..df9bf79be 100644 --- a/.claude/skills/playwright-triage/SKILL.md +++ b/.claude/skills/playwright-triage/SKILL.md @@ -1,60 +1,43 @@ --- name: playwright-triage -description: Triage and fix one microsoft/playwright-java issue, or do a maintainer's task, unattended inside the Issue triage GitHub Actions workflow (.github/workflows/triage.yml), which a needs-triage, needs-triage-mac or needs-triage-win label starts, or a maintainer starts by hand with an issue, a task or both. Reproduces the issue on the runner, then leaves a verified fix proposal for the workflow to open as a draft PR, an investigation note for it to post on the issue, or an upstream bug report for a maintainer to file in microsoft/playwright. Only for that workflow. +description: Triage and fix an issue in microsoft/playwright-java. Where the JavaScript client and the driver are upstream, how to run a published version, how to tell a bug of the Java client from an upstream one, the upstream bug report, and what not to run from a PR of a third party. --- # Playwright Java Issue Triage -You run unattended in the [Issue triage](../../../.github/workflows/triage.yml) workflow of -`microsoft/playwright-java`. First read the shared guide, `$AGENT_GUIDES_DIR/triage.md`, a copy of -[microsoft/playwright/.github/actions/run-agent/guides/triage.md](https://github.com/microsoft/playwright/blob/main/.github/actions/run-agent/guides/triage.md), -and then [AGENTS.md](../../../AGENTS.md), both in full. The guide says how to triage an issue in any -Playwright repo. AGENTS.md says how to build and test this one, and where a regression test goes. -This file covers what neither has: the checkouts, how to run a published version, and the outcome -that this repo adds, an upstream bug report. - -## The checkouts - -`$REPO_DIR` is the checkout of `microsoft/playwright-java` that the guide describes. The driver is -downloaded (`scripts/download_driver.sh`), the modules are built and installed -(`mvn -B install -D skipTests --no-transfer-progress`), and Chromium, Firefox and WebKit are -installed (`mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install --with-deps" -f playwright/pom.xml --no-transfer-progress`). -It is the working directory, and the checkout that the guides refer to. The JDK is JDK 8 (Zulu), -the JDK of the `dev` job in `.github/workflows/test.yml`. The project targets Java 8, so do not use -a newer language feature or library API. The clone is shallow: run -`git fetch --unshallow --tags origin` in it before you bisect or use `git tag --contains`. - -`$PLAYWRIGHT_DIR` is a shallow clone of `microsoft/playwright` at `main`. Read there the JavaScript -client that this repo ports, `packages/playwright-core/src/client/`, the API docs in -`docs/src/api/`, and the upstream tests in `tests/page/` and `tests/library/`. It is not at the -commit of the driver: `scripts/DRIVER_VERSION` in `$REPO_DIR` names the driver version, and -`npm view playwright@ gitHead` gives its upstream commit; `main` is close to it. The clone -is not built. Before you run an upstream test there, run `npm ci`, `npm run build` and -`npx playwright install` in it. Then `npm run ctest ` runs one spec in Chromium, +## Upstream + +This repo ports the JavaScript client of `microsoft/playwright`. Read it in a checkout of +`microsoft/playwright` at `main`, next to this repo, in `../playwright`: the client in +`packages/playwright-core/src/client/`, the API docs in `docs/src/api/`, and the upstream tests in +`tests/page/` and `tests/library/`. The driver is not at `main`: `scripts/DRIVER_VERSION` names the +driver version, and `npm view playwright@ gitHead` gives its upstream commit. `main` is +close to it. Before you run an upstream test in `../playwright`, run `npm ci`, `npm run build` and +`npx playwright install` there. Then `npm run ctest ` runs one spec in Chromium, `npm run ftest ` in Firefox and `npm run wtest ` in WebKit. ## Published versions The Maven artifact is `com.microsoft.playwright:playwright`. Release `1.X.0` bundles the driver named in `scripts/DRIVER_VERSION` at tag `v1.X.0`: `git show v1.64.0:scripts/DRIVER_VERSION` prints -`1.64.1`. Name both versions in the note. The version in `pom.xml` on `main` is a placeholder -snapshot; `scripts/DRIVER_VERSION` says what tip-of-tree runs. +`1.64.1`. Name both versions. The version in `pom.xml` on `main` is a placeholder snapshot; +`scripts/DRIVER_VERSION` says what tip-of-tree runs. -To run a published version, create `$SCRATCH_DIR/playwright-java-//` with a `pom.xml` -like `examples/pom.xml`: the dependency at ``, and `maven-compiler-plugin` with source and -target `1.8`. Put the repro in a class with a `main` method under `src/main/java/`, and run -`mvn -q compile exec:java -D exec.mainClass=` there. The first `Playwright.create()` +To run a published version, create an empty directory outside the repo for each version, with a +`pom.xml` like `examples/pom.xml`: the dependency at ``, and `maven-compiler-plugin` with +source and target `1.8`. Put the repro in a class with a `main` method under `src/main/java/`, and +run `mvn -q compile exec:java -D exec.mainClass=` there. The first `Playwright.create()` downloads the browsers of that version. To match a change between two releases, compare the driver versions of the two tags first. When they differ, `git log v..v -- ` in -`$PLAYWRIGHT_DIR` finds the change, after you unshallow that clone too; otherwise -`git log v..v -- playwright/src/main` in `$REPO_DIR` finds it. +`../playwright` finds the change; otherwise `git log v..v -- playwright/src/main` in this +repo finds it. ## Upstream bugs The Java client talks to the Node.js driver that `microsoft/playwright` publishes: the `playwright-core` npm package that `scripts/download_driver.sh` unpacks into `driver/src/main/resources/driver/package/`. After you reproduced a bug in Java, write the same -calls as an upstream test in `$PLAYWRIGHT_DIR` and run it there. When the bug reproduces in Node.js +calls as an upstream test in `../playwright` and run it there. When the bug reproduces in Node.js too, the root cause is in the driver or in a browser, and the fix lands in `microsoft/playwright`, which the family treats as one team. When Node.js passes, the bug is in the Java client: compare the `*Impl.java` with its JavaScript counterpart, and fix it here. @@ -63,11 +46,7 @@ For an upstream bug, write a report for a maintainer to file in `microsoft/playw engineer who did not read the Java issue: what fails, expected versus actual, the driver version, the browsers and the platform, the root cause when you found it, and the condensed Node.js test as the repro. The title has at most 256 characters, for example -`route.fulfill() ignores the charset in Content-Type`. - -The bot never files it: this run allows no `issue` call (the calls are in -`$AGENT_GUIDES_DIR/calls.d.ts`). Put the report at the end of your comment, for a maintainer to -file, in this form: +`route.fulfill() ignores the charset in Content-Type`. Give it in this form: `````markdown Upstream bug report, for a maintainer to file in microsoft/playwright: @@ -84,7 +63,7 @@ Upstream bug report, for a maintainer to file in microsoft/playwright: ````` -Write the rest of the comment as the note: the verdict, the evidence, and that the bug is upstream. +With it, give the verdict, the evidence, and that the bug is upstream. The public API is generated from the upstream docs: `scripts/generate_api.sh` runs upstream's `utils/doclint/generateApiJson.js` at the commit of the driver, and `tools/api-generator` writes @@ -92,7 +71,7 @@ every interface and options class in `playwright/src/main/java/com/microsoft/pla `options/` and `assertions/`; only `CLI.java`, `PlaywrightException.java`, `TimeoutError.java`, `assertions/PlaywrightAssertions.java` and the `package-info.java` files there are written by hand. Never edit a generated file: the next roll reverts it. A missing method or option is a change to -`docs/src/api/` upstream, so it ends in a report or a note, not in a fix here. +`docs/src/api/` upstream, so it ends in an upstream report, not in a fix here. ## PRs from third parties diff --git a/.github/actions/setup-triage-runner/action.yml b/.github/actions/setup-triage-runner/action.yml deleted file mode 100644 index 622b3d58c..000000000 --- a/.github/actions/setup-triage-runner/action.yml +++ /dev/null @@ -1,35 +0,0 @@ -name: 'Set up the triage runner' -description: > - Prepares the environment that the triage and revision agents work in: the checkout built as CI - builds it, with the browsers and the Copilot CLI installed, and a checkout of microsoft/playwright - to read the client that this repo ports. Exports PLAYWRIGHT_DIR, the path of that checkout, and - CI_ENV_EXEC, the wrapper from microsoft/playwright that runs a command under xvfb on Linux and at - normal I/O priority on Windows. -runs: - using: composite - steps: - - uses: microsoft/playwright/.github/actions/ci-env@d1518e3e3fca90352c4390814943cced496fd7e4 # main - - uses: actions/setup-java@03ad4de0992f5dab5e18fcb136590ce7c4a0ac95 # v5.6.0 - with: - distribution: zulu - java-version: 8 - - uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0 - with: - node-version: '24' - - name: Download the driver, build and install - shell: bash - run: | - scripts/download_driver.sh - mvn -B install -D skipTests --no-transfer-progress - - name: Install the browsers - shell: bash - run: mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install --with-deps" -f playwright/pom.xml --no-transfer-progress - - name: Check out microsoft/playwright - shell: bash - run: | - dir="${RUNNER_TEMP//\\//}/playwright" - git clone --quiet --depth 1 https://github.com/microsoft/playwright "$dir" - echo "PLAYWRIGHT_DIR=$dir" >> "$GITHUB_ENV" - - name: Install the Copilot CLI - shell: bash - run: npm install -g @github/copilot diff --git a/.github/workflows/review.yml b/.github/workflows/review.yml new file mode 100644 index 000000000..56f9ec912 --- /dev/null +++ b/.github/workflows/review.yml @@ -0,0 +1,33 @@ +# Hands the pull request to the Playwright bot when a maintainer applies agent-review. Nothing +# else of the bot lives in this repo. Apply the label again to start another run. +name: "Agent: review" + +on: + # Runs from the default branch, for PRs from forks too. It never checks out the PR. + pull_request_target: + types: [labeled] + +permissions: {} + +jobs: + pr: + name: Hand the PR to the bot + if: github.repository_owner == 'microsoft' && github.event.label.name == 'agent-review' + runs-on: ubuntu-latest + timeout-minutes: 5 + steps: + - uses: actions/create-github-app-token@64ab729a6294000f5aa4a4bc0b73d1f32bc45510 # v3.3.0 + id: app-token + with: + client-id: ${{ vars.PLAYWRIGHT_APP_CLIENT_ID }} + private-key: ${{ secrets.PLAYWRIGHT_PRIVATE_KEY }} + owner: microsoft + repositories: devops.playwright.dev + permission-actions: write + - name: Start the bot + env: + GH_TOKEN: ${{ steps.app-token.outputs.token }} + NUMBER: ${{ github.event.pull_request.number }} + run: >- + gh workflow run pr.yml --repo microsoft/devops.playwright.dev --ref main + -f repo="$GITHUB_REPOSITORY" -f pr="$NUMBER" diff --git a/.github/workflows/revision.yml b/.github/workflows/revision.yml deleted file mode 100644 index 66b9d9664..000000000 --- a/.github/workflows/revision.yml +++ /dev/null @@ -1,133 +0,0 @@ -# Copilot addresses the maintainers' review comments on a draft PR that the triage workflow opened, -# without write credentials. The agent leaves the calls to make on GitHub in calls.json. A fresh job -# checks them and makes them using the app: it pushes the new commit to the PR's branch, so CI runs -# on it, and replies in the review threads. The steps that are the same for every Playwright repo -# are actions in microsoft/playwright, and the shared guide they carry says how to revise; the -# prompt below has what is specific to this repo. -name: PR revision - -on: - # Apply needs-revision, needs-revision-mac or needs-revision-win; re-apply it to trigger another pass. - # pull_request_target always runs this file from main; the jobs only accept the triage app's own PRs. - pull_request_target: - types: [labeled] - -permissions: {} - -jobs: - prepare: - name: Collect the maintainers' comments - if: >- - github.repository == 'microsoft/playwright-java' && - contains(fromJSON('["needs-revision","needs-revision-mac","needs-revision-win"]'), github.event.label.name) && - github.event.pull_request.state == 'open' && - github.event.pull_request.user.login == 'microsoft-playwright-automation[bot]' && - github.event.pull_request.head.repo.full_name == github.repository - runs-on: ubuntu-latest - permissions: - issues: read - pull-requests: write - env: - PLATFORM: ${{ fromJSON('{"needs-revision":"linux","needs-revision-mac":"mac","needs-revision-win":"windows"}')[github.event.label.name] }} - outputs: - head: ${{ steps.collect.outputs.head }} - base: ${{ steps.collect.outputs.base }} - branch: ${{ steps.collect.outputs.branch }} - platform: ${{ env.PLATFORM }} - steps: - - name: Collect the PR and the maintainers' comments - id: collect - uses: microsoft/playwright/.github/actions/collect-review@d1518e3e3fca90352c4390814943cced496fd7e4 # main - with: - pull-request: ${{ github.event.pull_request.number }} - - name: Post the run link - env: - GH_TOKEN: ${{ github.token }} - PR: ${{ github.event.pull_request.number }} - PLATFORM_NAME: ${{ fromJSON('{"linux":"Linux","mac":"macOS","windows":"Windows"}')[env.PLATFORM] }} - RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} - run: | - body=$(printf "Hi, I'm the Playwright bot. I started to address the review comments on %s: [agent run](%s)\n" "$PLATFORM_NAME" "$RUN_URL") - gh pr comment "$PR" --body "$body" || echo "::warning::Could not post the run link" - - revise: - name: Revise PR ${{ github.event.pull_request.number }} (${{ needs.prepare.outputs.platform }}) - needs: prepare - runs-on: ${{ fromJSON('{"linux":"playwright-x64-ubuntu24-64-core","mac":"macos-15-xlarge","windows":"playwright-x64-server2025-64-core"}')[needs.prepare.outputs.platform] }} - timeout-minutes: 240 - concurrency: - group: revision-${{ github.event.pull_request.number }} - cancel-in-progress: false - defaults: - run: - shell: bash - env: - PR: ${{ github.event.pull_request.number }} - HEAD_SHA: ${{ needs.prepare.outputs.head }} - BASE_SHA: ${{ needs.prepare.outputs.base }} - TRIAGE_PLATFORM: ${{ needs.prepare.outputs.platform }} - permissions: - copilot-requests: write - outputs: - has_revision: ${{ steps.agent.outputs.has-result }} - steps: - - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 - with: - ref: ${{ needs.prepare.outputs.head }} - persist-credentials: false - - name: Fetch the base and record the directories - run: | - git fetch --no-tags --depth=1 origin "$BASE_SHA" - echo "OUTPUT_DIR=${RUNNER_TEMP//\\//}/revision" >> "$GITHUB_ENV" - echo "REVIEW_DIR=${RUNNER_TEMP//\\//}/review" >> "$GITHUB_ENV" - echo "SCRATCH_DIR=${RUNNER_TEMP//\\//}/scratch" >> "$GITHUB_ENV" - echo "REPO_DIR=${GITHUB_WORKSPACE//\\//}" >> "$GITHUB_ENV" - mkdir -p "${RUNNER_TEMP//\\//}/revision" "${RUNNER_TEMP//\\//}/scratch" - - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2 - with: - name: review - path: ${{ runner.temp }}/review - - name: Set up the runner - uses: ./.github/actions/setup-triage-runner - - name: Revise with Copilot CLI - id: agent - # No GitHub tools and no URL access: the agent reads the PR only from the review the prepare job filtered. - uses: microsoft/playwright/.github/actions/run-agent@d1518e3e3fca90352c4390814943cced496fd7e4 # main - with: - prompt: | - Follow the shared guide revision.md and this repo's AGENTS.md. Read both in full before starting. $PLAYWRIGHT_DIR is a shallow clone of microsoft/playwright at main, for reading the JavaScript client that this repo ports. - - Pull request: https://github.com/microsoft/playwright-java/pull/${{ github.event.pull_request.number }} - output-dir: ${{ env.OUTPUT_DIR }} - result-file: calls.json - artifact-name: revision - exec: ${{ env.CI_ENV_EXEC }} - - push: - name: Push the revision - needs: [prepare, revise] - # calls.json is written when the revision is done, so it is pushed even if the job failed later. - if: ${{ !cancelled() && needs.revise.outputs.has_revision == 'true' }} - runs-on: ubuntu-latest - steps: - - uses: actions/create-github-app-token@64ab729a6294000f5aa4a4bc0b73d1f32bc45510 # v3.3.0 - id: app-token - with: - app-id: ${{ vars.PLAYWRIGHT_APP_ID }} - private-key: ${{ secrets.PLAYWRIGHT_PRIVATE_KEY }} - permission-contents: write - permission-pull-requests: write - - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 - with: - ref: ${{ needs.prepare.outputs.head }} - token: ${{ steps.app-token.outputs.token }} - - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2 - with: - name: revision - path: ${{ runner.temp }}/revision - # Never execute code or scripts from the artifact in the app job. The calls are data. - - name: Check and make the calls - uses: microsoft/playwright/.github/actions/publish-calls@d1518e3e3fca90352c4390814943cced496fd7e4 # main - with: - token: ${{ steps.app-token.outputs.token }} - dir: ${{ runner.temp }}/revision diff --git a/.github/workflows/task.yml b/.github/workflows/task.yml new file mode 100644 index 000000000..e9c57ce38 --- /dev/null +++ b/.github/workflows/task.yml @@ -0,0 +1,36 @@ +# Starts the Playwright bot with the task that you type. The bot does it with the skills of this +# repo, and opens the pull request as the app. Start it from the Actions tab. +name: "Agent: task" + +on: + workflow_dispatch: + inputs: + task: + description: What the bot should do + type: string + required: true + +permissions: {} + +jobs: + start: + name: Hand the task to the bot + if: github.repository == 'microsoft/playwright-java' + runs-on: ubuntu-latest + timeout-minutes: 5 + steps: + - uses: actions/create-github-app-token@64ab729a6294000f5aa4a4bc0b73d1f32bc45510 # v3.3.0 + id: app-token + with: + client-id: ${{ vars.PLAYWRIGHT_APP_CLIENT_ID }} + private-key: ${{ secrets.PLAYWRIGHT_PRIVATE_KEY }} + owner: microsoft + repositories: devops.playwright.dev + permission-actions: write + - name: Start the bot + env: + GH_TOKEN: ${{ steps.app-token.outputs.token }} + TASK: ${{ inputs.task }} + run: >- + gh workflow run task.yml --repo microsoft/devops.playwright.dev --ref main + -f repo="$GITHUB_REPOSITORY" -f task="$TASK" diff --git a/.github/workflows/triage.yml b/.github/workflows/triage.yml index a44a9b0c9..aa39150dd 100644 --- a/.github/workflows/triage.yml +++ b/.github/workflows/triage.yml @@ -1,207 +1,38 @@ -# Copilot triages and fixes an issue, or works on a task given by hand, without write credentials. -# The agent leaves the calls to make on GitHub in calls.json. A fresh job posts the run link on the -# issue first. After the agent, a fresh job checks the calls and makes them using the app: it opens -# the fix as a draft PR, so CI runs on it, and comments on the issue. The steps that are the same -# for every Playwright repo are actions in microsoft/playwright. The skill in -# .claude/skills/playwright-triage/ has what is specific to this repo. -name: Issue triage +# Hands the issue to the Playwright bot when a maintainer applies agent-triage, agent-implement or +# agent-task. Nothing else of the bot lives in this repo. Apply the label again to start another +# run. +name: "Agent: triage" on: - # Apply needs-triage, needs-triage-mac or needs-triage-win; re-apply it to trigger another pass. issues: types: [labeled] - workflow_dispatch: - inputs: - issue: - description: "Issue number to triage; leave empty to work on the task alone" - type: string - required: false - default: "" - platform: - description: "Platform to triage on" - type: choice - required: true - default: linux - options: - - linux - - mac - - windows - task: - description: "Task to direct the triage, such as what to focus on; the whole job when there is no issue" - type: string - required: false - default: "" permissions: {} jobs: - start: - name: Post the run link on the issue - # The triage job's condition, for runs that have an issue. + issue: + name: Hand the issue to the bot if: >- - github.repository == 'microsoft/playwright-java' && - ((github.event_name == 'workflow_dispatch' && inputs.issue != '') || - contains(fromJSON('["needs-triage","needs-triage-mac","needs-triage-win"]'), github.event.label.name)) - runs-on: ubuntu-latest - permissions: - issues: write - outputs: - comment: ${{ steps.post.outputs.id }} - env: - ISSUE: ${{ github.event.issue.number || inputs.issue }} - PLATFORM_NAME: ${{ fromJSON('{"linux":"Linux","mac":"macOS","windows":"Windows","needs-triage":"Linux","needs-triage-mac":"macOS","needs-triage-win":"Windows"}')[inputs.platform || github.event.label.name] }} - GH_TOKEN: ${{ github.token }} - GH_REPO: ${{ github.repository }} - WORKFLOW_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} - steps: - - name: Post the run link - id: post - run: | - [[ "$ISSUE" =~ ^[1-9][0-9]*$ ]] || { echo "issue must be a positive integer" >&2; exit 1; } - body=$(printf "Hi, I'm the Playwright bot. I started to triage this issue on %s: [agent run](%s)\n" "$PLATFORM_NAME" "$WORKFLOW_URL") - id=$(gh api "repos/$GH_REPO/issues/$ISSUE/comments" -f body="$body" --jq .node_id) - echo "id=$id" >> "$GITHUB_OUTPUT" - - triage: - name: Triage ${{ (github.event.issue.number || inputs.issue) && format('issue {0}', github.event.issue.number || inputs.issue) || 'task' }} (${{ inputs.platform || github.event.label.name }}) - if: >- - github.repository == 'microsoft/playwright-java' && - (github.event_name == 'workflow_dispatch' || - contains(fromJSON('["needs-triage","needs-triage-mac","needs-triage-win"]'), github.event.label.name)) - # Falls back to a runner name for unrelated labels, where the job is skipped anyway. - runs-on: ${{ fromJSON('{"linux":"playwright-x64-ubuntu24-64-core","mac":"macos-15-xlarge","windows":"playwright-x64-server2025-64-core"}')[inputs.platform || fromJSON('{"needs-triage":"linux","needs-triage-mac":"mac","needs-triage-win":"windows"}')[github.event.label.name]] || 'ubuntu-latest' }} - timeout-minutes: 240 - concurrency: - group: triage-${{ github.event.issue.number || inputs.issue || github.run_id }} - cancel-in-progress: false - defaults: - run: - shell: bash - env: - ISSUE: ${{ github.event.issue.number || inputs.issue }} - TRIAGE_PLATFORM: ${{ inputs.platform || fromJSON('{"needs-triage":"linux","needs-triage-mac":"mac","needs-triage-win":"windows"}')[github.event.label.name] }} - TASK: ${{ inputs.task }} - permissions: - copilot-requests: write - outputs: - base: ${{ steps.base.outputs.sha }} - setup: ${{ steps.setup.outcome }} - agent: ${{ steps.agent.outputs.outcome }} - steps: - - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 - with: - ref: main - persist-credentials: false - - name: Record the base and the directories - id: base - run: | - if [[ -n "$ISSUE" ]]; then - [[ "$ISSUE" =~ ^[1-9][0-9]*$ ]] || { echo "issue must be a positive integer" >&2; exit 1; } - elif [[ -z "${TASK//[[:space:]]/}" ]]; then - echo "give an issue, a task or both" >&2; exit 1 - fi - echo "sha=$(git rev-parse HEAD)" >> "$GITHUB_OUTPUT" - echo "OUTPUT_DIR=${RUNNER_TEMP//\\//}/triage" >> "$GITHUB_ENV" - echo "SCRATCH_DIR=${RUNNER_TEMP//\\//}/scratch" >> "$GITHUB_ENV" - echo "REPO_DIR=${GITHUB_WORKSPACE//\\//}" >> "$GITHUB_ENV" - mkdir -p "${RUNNER_TEMP//\\//}/triage" "${RUNNER_TEMP//\\//}/scratch" - - name: Set up the runner - id: setup - uses: ./.github/actions/setup-triage-runner - - name: Write the prompt - id: prompt - run: | - delimiter="PROMPT_$RANDOM$RANDOM" - { - echo "prompt<<$delimiter" - echo "Follow .claude/skills/playwright-triage/SKILL.md. Read it, the guide and the AGENTS.md" - echo "it points to in full before starting." - if [[ -n "$ISSUE" ]]; then - printf '\nIssue: https://github.com/%s/issues/%s\n' "$GITHUB_REPOSITORY" "$ISSUE" - fi - if [[ -n "$TASK" ]]; then - printf '\nTask: %s\n' "$TASK" - fi - echo "$delimiter" - } >> "$GITHUB_OUTPUT" - - name: Triage with Copilot CLI - id: agent - uses: microsoft/playwright/.github/actions/run-agent@d1518e3e3fca90352c4390814943cced496fd7e4 # main - with: - prompt: ${{ steps.prompt.outputs.prompt }} - output-dir: ${{ env.OUTPUT_DIR }} - result-file: calls.json - artifact-name: triage - github-tools: true - exec: ${{ env.CI_ENV_EXEC }} - - publish: - name: Publish the results - needs: [start, triage] - # Runs after every triage run, also a failed one: without a comment from the agent, the comment - # says why the bot could not finish. - if: ${{ !cancelled() && needs.triage.result != 'skipped' }} + github.repository_owner == 'microsoft' && ( + github.event.label.name == 'agent-triage' || + github.event.label.name == 'agent-implement' || + github.event.label.name == 'agent-task') runs-on: ubuntu-latest + timeout-minutes: 5 steps: - uses: actions/create-github-app-token@64ab729a6294000f5aa4a4bc0b73d1f32bc45510 # v3.3.0 id: app-token with: - app-id: ${{ vars.PLAYWRIGHT_APP_ID }} + client-id: ${{ vars.PLAYWRIGHT_APP_CLIENT_ID }} private-key: ${{ secrets.PLAYWRIGHT_PRIVATE_KEY }} - permission-contents: write - permission-issues: write - permission-pull-requests: write - - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 - with: - ref: ${{ needs.triage.outputs.base }} - token: ${{ steps.app-token.outputs.token }} - - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2 - # A failed triage run may not have uploaded anything. - continue-on-error: true - with: - name: triage - path: ${{ runner.temp }}/triage - # Without a comment from the agent on the issue, for example after a failed run, the issue gets - # one that says that the bot could not finish. - - name: Add a comment when the agent left none - if: github.event.issue.number || inputs.issue - env: - CALLS: ${{ runner.temp }}/triage/calls.json - ISSUE: ${{ github.event.issue.number || inputs.issue }} - SETUP: ${{ needs.triage.outputs.setup }} - AGENT: ${{ needs.triage.outputs.agent }} - FOOTER: Triaged on ${{ fromJSON('{"linux":"Linux","mac":"macOS","windows":"Windows","needs-triage":"Linux","needs-triage-mac":"macOS","needs-triage-win":"Windows"}')[inputs.platform || github.event.label.name] }} by the Playwright bot - RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} - run: | - mkdir -p "$(dirname "$CALLS")" - if jq -e --argjson issue "$ISSUE" 'any(.[]; .call == "comment" and .issue == $issue)' "$CALLS" > /dev/null 2>&1; then - exit 0 - fi - if [[ "$SETUP" == "failure" ]]; then - reason="setting up the runner failed" - elif [[ "$AGENT" == "failure" ]]; then - reason="the Copilot session failed or ran out of budget" - else - reason="the session ended without a comment" - fi - body=$(printf "Hi, I'm the Playwright bot. I couldn't finish triaging this issue: %s. The agent run has the details.\n\n%s - [agent run](%s)\n" "$reason" "$FOOTER" "$RUN_URL") - comment=$(jq -n --arg repo "$GITHUB_REPOSITORY" --argjson issue "$ISSUE" --arg body "$body" '{call: "comment", repo: $repo, issue: $issue, body: $body}') - # A calls.json that is not an array is replaced: its calls would be rejected anyway. - jq --argjson comment "$comment" '. + [$comment]' "$CALLS" > "$CALLS.tmp" 2> /dev/null \ - || jq -n --argjson comment "$comment" '[$comment]' > "$CALLS.tmp" - mv "$CALLS.tmp" "$CALLS" - # Never execute code or scripts from the artifact in the app job. The calls are data. - - name: Check and make the calls - id: publish - uses: microsoft/playwright/.github/actions/publish-calls@d1518e3e3fca90352c4390814943cced496fd7e4 # main - with: - token: ${{ steps.app-token.outputs.token }} - dir: ${{ runner.temp }}/triage - - name: Hide the comment with the run link - if: ${{ !cancelled() && steps.publish.outputs.comment == 'true' && needs.start.outputs.comment != '' }} + owner: microsoft + repositories: devops.playwright.dev + permission-actions: write + - name: Start the bot env: GH_TOKEN: ${{ steps.app-token.outputs.token }} - ID: ${{ needs.start.outputs.comment }} - run: | - gh api graphql -f query='mutation($id: ID!) { minimizeComment(input: { subjectId: $id, classifier: OUTDATED }) { clientMutationId } }' -f id="$ID" \ - || echo "::warning::Could not hide the comment with the run link" + NUMBER: ${{ github.event.issue.number }} + LABEL: ${{ github.event.label.name }} + run: >- + gh workflow run issue.yml --repo microsoft/devops.playwright.dev --ref main + -f repo="$GITHUB_REPOSITORY" -f issue="$NUMBER" -f label="$LABEL"