mirror of
https://github.com/microsoft/playwright.git
synced 2024-12-15 22:22:53 +03:00
1.7 KiB
1.7 KiB
Releasing is a 3-step process.
1. Create a release branch
- Bump a version to the new
-post
version and land achore: cut vX.Y.Z-post version
commit
./utils/update_version.js vX.Y.Z-post
- On your local machine, create a new branch
release-X.Y
based off the "cutting" commit and land achore: mark vX.Y.Z
in the local branch:
git checkout master
git checkout -b release-X.Y
./utils/update_version.js vX.Y
npm run doc
git commit -am 'chore: mark vX.Y.Z'
- Push branch to the upstream
git push upstream release-X.Y
Once release branch is pushed, it's last commit will be picked up by our CI/CD:
- make sure commit passes all the bots. If there are any failures, carefully inspect failures to see if these are flakes.
- the
publish_canary
workflow will publish a@next
version for the commit - this will be our release candidate. Go manually to it's page on NPM to see what it looks like. Try installing locally.
2. Prepare release notes
- Use "draft new release tag".
- Version starts with "v", e.g. "vX.Y.Z".
- Run
./utils/draft_release_notes.sh
and fill in the "TODO" in generated text. - When making links to the API, copy actual links from GitHub, and not from
api.md
source - these might be incorrect.- Before publishing, replace
blob/master/docs
withblob/vX.Y.Z/docs
in all the links.
- Before publishing, replace
- Use "Save Draft", not "Publish".
3. Publish Release
- Hit "publish release"
Once release is published, the publish_release
will kick in and publish package version on NPM.