home / skills / microsoft / playwright-cli / dev

dev skill

safe

This skill guides rolling Playwright dependencies, releasing, and repo maintenance to keep your dev workflow smooth and up to date.

npx playbooks add skill microsoft/playwright-cli --skill dev

Review the files below or copy the command above to add this skill to your agents.

Files (2)

SKILL.md

261 B

---
name: dev
description: Development workflows for the playwright-cli repository. Use when the user asks about rolling dependencies, releasing, or other repo maintenance tasks.
---

# Development skills

* **Rolling Playwright dependency** [roll.md](roll.md)

Overview

This skill provides guidance for development workflows and maintenance tasks for the playwright-cli repository. It focuses on rolling the Playwright dependency, performing releases, and common repository upkeep to keep the CLI current and stable. Use it when you need step-by-step actions, checks, and recommended practices for repo maintenance.

How this skill works

It inspects the repository's TypeScript codebase, dependency declarations, CI configuration, and release scripts to determine the required steps for dependency updates and releases. The skill outlines the sequence: update dependency versions, run tests, adjust code for API changes, update changelogs, and push a release. It also highlights CI checks and local validation required before merging.

When to use it

You need to roll the Playwright dependency to a newer version.
Preparing a new release of the CLI (version bump, changelog, publish).
Fixing breakages caused by upstream Playwright API changes.
Updating CI, test fixtures, or recorder artifacts related to Playwright changes.
Routine maintenance tasks like dependency cleanup or TypeScript upgrades.

Best practices

Run the full test suite and recorder-generated scenarios locally before opening a PR.
Pin the Playwright version in package manifests and update lockfiles atomically.
Check CI matrix for Node versions and platform-specific behavior after a roll.
Document API-incompatible changes in the changelog and link to upstream release notes.
Perform incremental rolls if major API changes require staged fixes; avoid large monolithic updates.

Example use cases

Roll Playwright from vX.Y.Z to vA.B.C: update package.json, regenerate lockfile, run tests, fix selector/recorder diffs, commit and open PR.
Release a new CLI version: bump package version, update changelog with notable changes, run build, tag commit, and publish artifacts.
Troubleshoot recorder or inspector regressions after an upstream change: reproduce locally, capture failing scenario, and add a test or hotfix.
Update CI to test new Node versions when Playwright or TypeScript requires newer runtimes.

FAQ

How do I handle breaking Playwright API changes?

Update the dependency in a feature branch, run tests to find incompatibilities, implement targeted fixes, and document breaking changes in the changelog. Prefer incremental rolls if many fixes are needed.

What validations should run before merging a dependency roll?

Run the full test suite, recorder-generated scenarios, linting, and CI matrix checks across supported Node versions and platforms. Confirm lockfile updates and ensure no new flaky tests appear.