Skip to content

Latest commit

 

History

History
70 lines (46 loc) · 2.43 KB

RELEASE_CHECKLIST.md

File metadata and controls

70 lines (46 loc) · 2.43 KB
Raw

Release Checklist

This is a list of the things that need to happen during a release.

Build a Release

Prepare the Changelog

  1. Open the associated milestone. All issues and PRs should be closed. If they are not you should reassign all open issues and PRs to future milestones.
  2. Go through the PR history since the last release. Ensure that all PRs that have landed are marked with the milestone. You can use this to show all the PRs that are merged on or after YYY-MM-DD: https://github.com/issues?q=repo%3Acloudflare%2Fworkers-types+merged%3A%3E%3DYYYY-MM-DD
  3. Add this release to CHANGELOG.md. Use the structure of previous entries.
  4. Go through the closed PRs in the milestone. For each, add an entry to CHANGELOG.md.

Start a release PR

  1. Create a new branch "#.#.#" where "#.#.#" is this release's version (release) or "#.#.#-rc.#" (release candidate)
  2. Update the version number in package.json.
  3. Push up a commit with the CHANGELOG.md changes. The commit message can just be "#.#.#" (release) or "#.#.#-rc.#" (release candidate)
  4. Request review from maintainers.

Review

Most of your comments will be about the changelog. Once the PR is finalized and approved...

  1. If you made changes, squash or fixup all changes into a single commit.
  2. Run git push and wait for CI to pass.

Tag and build release

  1. Once ready to merge, tag the commit by running git tag -a v#.#.# -m #.#.#
  2. Run git push --tags.
  3. Wait for CI to pass.

Edit the release

Draft a new release on the releases page and update release notes.

Publish to npm

Full releases are tagged latest. If for some reason you mix up the commands below, follow the troubleshooting guide.

  1. cd npm && npm publish.
  2. Tweet.

Troubleshooting a release

Mistakes happen. Most of these release steps are recoverable if you mess up. The goal is not to, but if you find yourself cursing a fat fingered command, here are some troubleshooting tips. Please feel free to add to this guide.

I pushed the wrong tag

Tags and releases can be removed in GitHub. First, remove the remote tag:

$ git push --delete origin tagname

This will turn the release into a draft and you can delete it from the edit page.

Make sure you also delete the local tag:

$ git tag --delete vX.X.X