playwright/docs/releasing.md
2020-02-28 14:40:50 -08:00

1.0 KiB

Preparing release notes

  1. Use "draft new release tag".
  2. Version starts with "v", e.g. "v1.1.0".
  3. Fill "Raw notes".
    • git fetch --tags upstream
    • git log --pretty="%h - %s" v1.0.0..HEAD
  4. Fill "Bug fixes".
    • git log v0.11.1..HEAD
    • Manually look for #1234 references in commit messages.
  5. Fill "Current status".
  6. Fill "Highlights" if any.
    • Be creative.
  7. Fill "Breaking API Changes" if any.
    • git diff v0.11.1:docs/api.md docs/api.md
  8. Fill "New APIs" if any.
    • git diff v0.11.1:docs/api.md docs/api.md
  9. 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 with blob/v1.1.0/docs in all the links.
  10. Use "Save Draft", not "Publish".