From 1084008f1a81608cc1ee3296b1314bf340ed8bea Mon Sep 17 00:00:00 2001 From: Dmitry Gozman Date: Tue, 24 Mar 2020 10:53:36 -0700 Subject: [PATCH] chore: update release guide --- docs/development/releasing.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/development/releasing.md b/docs/development/releasing.md index 3af5c4975c..324ceb9206 100644 --- a/docs/development/releasing.md +++ b/docs/development/releasing.md @@ -1,10 +1,10 @@ # Preparing release notes 1. Use ["draft new release tag"](https://github.com/microsoft/playwright/releases/new). -1. Version starts with "v", e.g. "v1.1.0". +1. Version starts with "v", e.g. "vX.Y.Z". 1. Fill "Raw notes". - `git fetch --tags upstream` - - `git log --pretty="%h - %s" v1.0.0..HEAD` + - `git log --pretty="%h - %s" v0.11.1..HEAD` 1. Fill "Bug fixes". - `git log v0.11.1..HEAD` - Manually look for `#1234` references in commit messages. @@ -18,24 +18,24 @@ 1. Fill "New APIs" if any. - `git diff v0.11.1:docs/api.md docs/api.md` 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. - - Before publishing, replace `blob/master/docs` with `blob/v1.1.0/docs` in all the links. + - Before publishing, replace `blob/master/docs` with `blob/vX.Y.Z/docs` in all the links. 1. Use "Save Draft", not "Publish". # Releasing to npm -1. Announce `PSA: release vXXX.YYY.ZZZ in progress. Please do not commit anything.` +1. Announce `PSA: release vX.Y.Z in progress. Please do not commit anything.` - **Important**: no other commits should land in-between release commit and bump commit. 1. Mark a new version. - - Bump `package.json` version to `vXXX.YYY.ZZZ`. + - Bump `package.json` version to `vX.Y.Z`. - `node utils/sync_package_versions.js && npm run doc`. - - Send a PR titled `chore: mark version vXXX.YYY.ZZZ`. + - Send a PR titled `chore: mark version vX.Y.Z`. - Make sure the PR passes all required checks and merge it. 1. Publish to npm. - `npm login` - `utils/publish_all_packages.sh --release` 1. Click 'Publish release' button on the prepared release notes. 1. Mark post release. - - Bump `package.json` version to `vXXX.YYY.ZZZ-post`. + - Bump `package.json` version to `vX.Y.Z-post`. - `node utils/sync_package_versions.js && npm run doc`. - - Merge a PR titled `chore: bump version to vXXX.YYY.ZZZ-post`. -1. Announce `PSA: release vXXX.YYY.ZZZ is out.` + - Merge a PR titled `chore: bump version to vX.Y.Z-post`. +1. Announce `PSA: release vX.Y.Z is out.`