Skip to content

Commit

Permalink
docs(releasing): update releasing docs according to new process (#1958)
Browse files Browse the repository at this point in the history
  • Loading branch information
aslushnikov authored Apr 24, 2020
1 parent 3c71125 commit 4b263d6
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 29 deletions.
65 changes: 36 additions & 29 deletions docs/development/releasing.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,46 @@
# Preparing release notes
Releasing is a 3-step process.

# 1. Create a release branch

1. Bump a version to the new `-post` version and land a `chore: cut vX.Y.Z-post version` commit
- `./utils/update_version.js vX.Y.Z-post`
1. On your local machine, create a new branch `release-X.Y` based off the "cutting" commit and land a `chore: 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'`
1. 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`](../../.github/workflows/publish_canary.yml) 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

1. Use ["draft new release tag"](https://github.com/microsoft/playwright/releases/new).
1. Version starts with "v", e.g. "vX.Y.Z".
1. Fill "Raw notes".
- `git fetch --tags upstream`
- `git log --pretty="%h - %s" $(git describe --tags --abbrev=0)..HEAD`
1. Fill "Bug fixes".
- `git log $(git describe --tags --abbrev=0)..HEAD`
- 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 "Browser versions".
- `./utils/print_versions.js`
1. Fill "Highlights" if any.
- Be creative.
1. Fill "Breaking API Changes" if any.
- `git diff $(git describe --tags --abbrev=0):docs/api.md docs/api.md`
1. Fill "New APIs" if any.
- `git diff $(git describe --tags --abbrev=0):docs/api.md docs/api.md`
- `git diff $(git describe --tags $(git rev-list --tags --max-count=1)):docs/api.md docs/api.md`
1. Fill "Breaking API Changes" if any.
- `git diff $(git describe --tags $(git rev-list --tags --max-count=1)):docs/api.md docs/api.md`
1. Fill "Bug fixes".
- `git log $(git describe --tags $(git rev-list --tags --max-count=1))..HEAD`
- Manually look for `#1234` references in commit messages.
1. Fill "Raw notes".
- `git fetch --tags upstream`
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/vX.Y.Z/docs` in all the links.
1. Use "Save Draft", not "Publish".

# Releasing to npm

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.
- `node utils/update_version.js vX.Y.Z && npm run doc`.
- 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.
- `node utils/update_version.js vX.Y.Z-post && npm run doc`.
- Merge a PR titled `chore: bump version to vX.Y.Z-post`.
1. Announce `PSA: release vX.Y.Z is out.`
# 3. Publish Release

1. Hit "publish release"

Once release is published, the [`publish_release`](../../.github/workflows/publish_release.yml) will kick in and publish package version on NPM.

1 change: 1 addition & 0 deletions utils/print_versions.js
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#!/usr/bin/env node
/**
* Copyright (c) Microsoft Corporation.
*
Expand Down

0 comments on commit 4b263d6

Please sign in to comment.