Skip to content

release.md

Latest commit

 

History

History
69 lines (50 loc) · 3.09 KB

release.md

File metadata and controls

69 lines (50 loc) · 3.09 KB
name release
description Prepare a playwright-mcp release — roll Playwright, bump the version, and write GitHub release notes that combine changes from this repo and upstream microsoft/playwright since the last release.

Preparing a Release

Most MCP source lives upstream at ~/playwright/packages/playwright-core/src/tools/ (and tests/mcp/). A release combines an upstream Playwright roll, a version bump in this repo, and release notes that draw from both.

1. Roll Playwright

Follow the "Rolling Playwright" steps in CLAUDE.md: run node roll.js, branch as roll-pw-<version-suffix>, run npm test, and open a chore: roll Playwright to <version> PR. Wait for it to merge into main before proceeding.

2. Bump the version (PR off main)

git checkout main && git pull
git checkout -b mark-v0.0.<next>
# Bump "version" in package.json, package-lock.json (both occurrences), and server.json (both occurrences)
git commit -am "chore: mark v0.0.<next>"
git push -u origin mark-v0.0.<next>
gh pr create --repo microsoft/playwright-mcp --head <user>:mark-v0.0.<next> \
  --title "chore: mark v0.0.<next>" --body "## Summary
- Bump version to 0.0.<next>"

3. Find the cutoff

# Last published release and its date
gh release list --repo microsoft/playwright-mcp --limit 5

# Format reference — use the most recent non-trivial release
gh release view v0.0.<prev> --repo microsoft/playwright-mcp

# Playwright version that shipped in the last release
git show <prev-release-commit>:package.json | grep -E '"playwright|"@playwright"'
# Convert the alpha timestamp to a UTC date for the upstream log filter
date -r <timestamp_seconds> -u

4. Collect changes

# Upstream playwright (MCP code path widened to catch tools/cli/dashboard/extension too)
cd ~/playwright
git log --since="<prev UTC>" --until="<new UTC>" --oneline -- \
  packages/playwright-core/src/tools/ packages/playwright-core/src/extension/ tests/mcp/

# This repo
cd -
git log <last-release-commit>..HEAD --oneline

Filter for feat(mcp), fix(mcp), feat(extension), fix(extension), and dashboard changes. Many extension PRs land in both repos because the extension source lives upstream now — prefer the microsoft/playwright PR link. Use git show <sha> --stat to disambiguate when a commit subject is ambiguous. Drop reverted commits, test-only changes, docs, and anything not user-visible.

5. Write release-notes.md

Follow the format from the prior release: ## What's New (with ### New Tools, ### Tool Improvements, optional ### Browser Extension, ### Dashboard, ### Other Changes) and ## Bug Fixes. Link each entry to its PR ([#NNNNN](https://github.com/microsoft/playwright/pull/NNNNN) or the playwright-mcp equivalent). Do not mention features that are not yet enabled by default — confirm with the user before listing experimental flags.

6. Create the draft release

gh release create v0.0.<next> --repo microsoft/playwright-mcp \
  --draft --title "v0.0.<next>" --target main \
  --notes-file release-notes.md

Publish the draft once the mark PR is merged.