2020-02-28 14:40:50 -08:00
# Preparing release notes
1. Use ["draft new release tag" ](https://github.com/microsoft/playwright/releases/new ).
2020-03-24 10:53:36 -07:00
1. Version starts with "v", e.g. "vX.Y.Z".
2020-02-28 14:40:50 -08:00
1. Fill "Raw notes".
- `git fetch --tags upstream`
2020-03-25 13:15:29 -07:00
- `git log --pretty="%h - %s" $(git describe --tags --abbrev=0)..HEAD`
2020-02-28 14:40:50 -08:00
1. Fill "Bug fixes".
2020-03-25 13:15:29 -07:00
- `git log $(git describe --tags --abbrev=0)..HEAD`
2020-02-28 14:40:50 -08:00
- Manually look for `#1234` references in commit messages.
1. Fill "Current status".
- `node utils/print_versions.js`
- Copy tests status from [IsPlaywrightReady ](https://aslushnikov.github.io/isplaywrightready/ ).
1. Fill "Highlights" if any.
- Be creative.
1. Fill "Breaking API Changes" if any.
2020-03-25 13:15:29 -07:00
- `git diff $(git describe --tags --abbrev=0):docs/api.md docs/api.md`
2020-02-28 14:40:50 -08:00
1. Fill "New APIs" if any.
2020-03-25 13:15:29 -07:00
- `git diff $(git describe --tags --abbrev=0):docs/api.md docs/api.md`
2020-02-28 14:40:50 -08:00
1. When making links to the API, copy actual links from [GitHub ](https://github.com/microsoft/playwright/blob/master/docs/api.md ), and not from `api.md` source - these might be incorrect.
2020-03-24 10:53:36 -07:00
- Before publishing, replace `blob/master/docs` with `blob/vX.Y.Z/docs` in all the links.
2020-02-28 14:40:50 -08:00
1. Use "Save Draft", not "Publish".
2020-03-23 14:55:26 -07:00
# Releasing to npm
2020-03-24 10:53:36 -07:00
1. Announce `PSA: release vX.Y.Z in progress. Please do not commit anything.`
2020-03-23 18:11:59 -07:00
- **Important**: no other commits should land in-between release commit and bump commit.
2020-03-23 14:55:26 -07:00
1. Mark a new version.
2020-03-25 13:15:29 -07:00
- `node utils/update_version.js vX.Y.Z && npm run doc` .
2020-03-24 10:53:36 -07:00
- Send a PR titled `chore: mark version vX.Y.Z` .
2020-03-23 18:11:59 -07:00
- Make sure the PR passes all required checks and merge it.
2020-03-23 14:55:26 -07:00
1. Publish to npm.
- `npm login`
2020-03-24 10:50:23 -07:00
- `utils/publish_all_packages.sh --release`
2020-03-23 18:11:59 -07:00
1. Click 'Publish release' button on the prepared release notes.
2020-03-23 14:55:26 -07:00
1. Mark post release.
2020-03-25 13:15:29 -07:00
- `node utils/update_version.js vX.Y.Z-post && npm run doc` .
2020-03-24 10:53:36 -07:00
- Merge a PR titled `chore: bump version to vX.Y.Z-post` .
1. Announce `PSA: release vX.Y.Z is out.`