This is a list of the things that need to happen during a release.
- Open the associated milestone, if it exists. All issues and PRs should be closed. If they are not you should reassign all open issues and PRs to future milestones.
- Run the changelog generator in
./changelog-generator
.- Get the date after the most recent release,
- run
cd ./changelog-generator && npm install && node index.js cloudflare wrangler YYYY-MM-DD
- the generated changelog is in
./changelog-generator/output.md
. Open it, and add the version at the top, and move the entries to their proper category.
- Choose an emoji for the release. Try to make it semi-related to something that's been included in the release (point releases can be a little weirder).
- Add the contents of
output.md
to the top ofCHANGELOG.md
, matching the structure of previous entries. If it is a release candidate, no official changelog is needed, but testing instructions will be added later in the process.
- Update the version in
Cargo.toml
. - Run
cargo update
. - Run
cargo test
. - Run
cargo build
.
- Copy
README.md
tonpm/README.md
- Bump the version number in
npm/package.json
cd npm && npm install
Note: This step will appear to fail due to the new version not existing yet, however its utility is re-building npm-shrinkwrap.json
- Create a new branch "#.#.#" where "#.#.#" is this release's version (release) or "#.#.#-rc.#" (release candidate)
- Push up a commit with the
Cargo.toml
,Cargo.lock
,npm/README.md
,npm/package.json
,npm/npm-shrinkwrap.json
, andCHANGELOG.md
changes. The commit message can just be "#.#.#" (release) or "#.#.#-rc.#" (release candidate) - Request review from the @cloudflare/workers-devexp team.
Most of your comments will be about the changelog. Once the PR is finalized and approved...
- If you made changes, squash or fixup all changes into a single commit.
- Run
git push
and wait for CI to pass.
- Hit the big green Merge button on the release PR.
git checkout master
andgit pull --rebase origin master
This part of the release process is handled by GitHub Actions, and our binaries are distributed as GitHub Releases. When you push a version tag, it kicks off an action that creates a new GitHub release for that tag, builds release binaries and attaches them to the release.
- After pulling
master
in the step above, tag the commit by running eithergit tag -a v#.#.# -m #.#.#
(release), orgit tag -a v#.#.#-rc.# -m #.#.#
(release candidate) - Run
git push --tags
. - Wait for CI to pass.
- If CI fails, delete the tag locally and remotely
- Fix whatever caused the CI failure
- Re-tag the healthy commit, and wait for CI to pass again.
After CI builds the release binaries and they appear on the releases page, click Edit
and update release notes.
- Paste the current release notes from
CHANGELOG.md
into the release body. - Update the title of the release (not the tag itself) to include the emoji for the current release
- Be sure to add any missing link definitions to the release.
-
Mark the release as a
pre-release
. This is handled with a checkbox on the Edit page. -
If this is a new rc (rc.0), paste testing instructions into the release notes.
-
If this is a rc.1 or later, the old release candidate testing instructions should be moved to the latest release candidate testing instructions, and replaced with the following message:
This beta release is now out of date. If you previously installed this release, you should reinstall with `npm i -g @cloudflare/wrangler@beta` and see what's changed in the latest [release](https://github.com/cloudflare/wrangler/releases).
The new release candidate should then include updated testing instructions with a small changelog at the top to get folks who installed the old release candidate up to speed.
IMPORTANT: This step is the hardest to fix if you mess it up. Do not run this step for Release Candidates.
We don't publish release candidates to crates.io because they don't (as of this writing) have a concept of a "beta" version.
- Run
cargo test
- (Release only)
cargo publish
Full releases are tagged latest
. Release candidates are tagged beta
. If for some reason you mix up the commands below, follow the troubleshooting guide.
- If this is a full release,
cd npm && npm publish
. If it is a release candidate,cd npm && npm publish --tag beta
- Tweet.
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.
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
Never fear! We can fix this by updating npm tags. First, add a beta tag for the version you just published:
$ npm dist-tag add @cloudflare/wrangler@x.x.x-rc.x beta
once you add the beta tag, pause...
...and then list your tags:
$ npm dist-tag ls @cloudflare/wrangler
You should now see two tags pointing to the version you just pushed; for example if you had tried to push v1.9.0-rc.0:
$ npm dist-tag ls @cloudflare/wrangler
beta: 1.9.0-rc.0
latest: 1.9.0-rc.0
Go back to the Changelog or GitHub releases, find the actual latest version, and re-tag it as latest:
$ npm dist-tag add @cloudflare/wrangler@x.x.x latest
List tags again and you should see the latest restored, and your new release candidate as beta (e.g. 1.9.0-rc.0 is beta and 1.8.4 was last stable version)
$ npm dist-tag ls @cloudflare/wrangler
beta: 1.9.0-rc.0
latest: 1.8.4