mirror of
https://github.com/denoland/deno.git
synced 2024-12-04 17:18:23 -05:00
169 lines
5.6 KiB
Markdown
169 lines
5.6 KiB
Markdown
- [ ] Fork this gist and follow the instructions there.
|
|
|
|
## Pre-flight
|
|
|
|
**During this process $BRANCH_NAME branch should be frozen and no commits should
|
|
land until the release is finished.**
|
|
|
|
- [ ] Ensure forks and local clones of:
|
|
- [`denoland/deno`](https://github.com/denoland/deno/),
|
|
- [`denoland/dotcom`](https://github.com/denoland/dotcom/),
|
|
- [`denoland/deno_docker`](https://github.com/denoland/deno_docker/),
|
|
- [`denoland/deno-docs`](https://github.com/denoland/deno-docs)
|
|
- [ ] Check https://deno.land/benchmarks?-100 and ensure there's no recent
|
|
regressions.
|
|
- [ ] Write a message in company's `#cli` channel:
|
|
|
|
```
|
|
:lock:
|
|
|
|
@here
|
|
|
|
Deno v$VERSION is now getting released.
|
|
|
|
`denoland/deno` is now locked.
|
|
|
|
*DO NOT LAND ANY PRs*
|
|
|
|
Release checklist: <LINK TO THIS FORKED GIST GOES HERE>
|
|
```
|
|
|
|
## Patch release preparation
|
|
|
|
⛔ **If you are cutting a patch release**: First you need to sync commits to the
|
|
`v$MINOR_VERSION` branch in the `deno` repo.
|
|
|
|
To do that, you need to cherry-pick commits from the main branch to the
|
|
`v$MINOR_VERSION` branch. If the branch doesn't exist yet, create one from the
|
|
latest minor tag:
|
|
|
|
```
|
|
# checkout latest minor release
|
|
$ git checkout v$PAST_VERSION
|
|
|
|
# create a branch
|
|
$ git checkout v$MINOR_VERSION
|
|
|
|
# push the branch to the `denoland/deno` repository
|
|
$ git push upstream v$MINOR_VERSION
|
|
```
|
|
|
|
For patch releases we want to cherry-pick all commits that do not add features
|
|
to the CLI. This generally means to filter out `feat` commits.
|
|
|
|
Check what was the last commit on `v$MINOR_VERSION` branch before the previous
|
|
release and start cherry-picking newer commits from the `main`.
|
|
|
|
<!--
|
|
TODO: we should add sample deno program that does that for you,
|
|
and then provides a complete `git` command to run.
|
|
-->
|
|
|
|
Once all relevant commits are cherry-picked, push the branch to the upstream and
|
|
verify on GitHub that everything looks correct.
|
|
|
|
- ⛔ DO NOT create a `v$VERSION`-like branch! You are meant to cherry pick to
|
|
the `v$MINOR_VERSION` branch. If you have accidentally created then
|
|
`v$VERSION` branch then delete it as tagging the CLI will fail otherwise.
|
|
|
|
## Updating `deno`
|
|
|
|
### Phase 1: Bumping versions
|
|
|
|
- [ ] Go to the "version_bump" workflow in the CLI repo's actions:
|
|
https://github.com/denoland/deno/actions/workflows/version_bump.yml
|
|
1. Click on the "Run workflow" button.
|
|
1. In the drop down, select the minor branch (`v$MINOR_VERSION`) if doing a
|
|
patch release or the main branch if doing a minor release.
|
|
1. For the kind of release, select either `patch` or `minor`.
|
|
1. Run the workflow.
|
|
|
|
- [ ] Wait for the workflow to complete and for a pull request to be
|
|
automatically opened. Review the pull request, make any necessary changes,
|
|
and merge it.
|
|
- ⛔ **DO NOT** create a release tag manually That will automatically happen.
|
|
|
|
<details>
|
|
<summary>Failure Steps</summary>
|
|
|
|
1. Checkout the branch the release is being made on.
|
|
2. Manually run `./tools/release/01_bump_crate_versions.ts`
|
|
1. Ensure the crate versions were bumped correctly
|
|
2. Ensure `Releases.md` was updated correctly
|
|
3. Open a PR with the changes and continue with the steps below.
|
|
</details>
|
|
|
|
### Phase 2: Publish
|
|
|
|
- [ ] Go to the "cargo_publish" workflow in the CLI repo's actions:
|
|
https://github.com/denoland/deno/actions/workflows/cargo_publish.yml
|
|
1. Run it on the same branch that you used before and wait for it to complete.
|
|
|
|
<details>
|
|
<summary>Failure Steps</summary>
|
|
|
|
1. The workflow was designed to be restartable. Try restarting it.
|
|
2. If that doesn't work, then do the following:
|
|
1. Checkout the `v$MINOR_VERSION` branch.
|
|
2. If `cargo publish` hasn't completed then run
|
|
`./tools/release/03_publish_crates.ts`
|
|
- Note that you will need access to crates.io so it might fail.
|
|
3. If `cargo publish` succeeded and a release tag wasn't created, then
|
|
manually create and push the `v$VERSION` tag on the `v$MINOR_VERSION`
|
|
branch.
|
|
</details>
|
|
|
|
- [ ] This CI run create a tag which triggers a second CI run that publishes the
|
|
GitHub draft release.
|
|
|
|
The CI pipeline will create a release draft on GitHub
|
|
(https://github.com/denoland/deno/releases).
|
|
|
|
- ⛔ Verify that:
|
|
- [ ] There are 24 assets on the
|
|
[GitHub release draft](https://github.com/denoland/deno/releases/v$VERSION).
|
|
- [ ] There are 10 zip files for this version on
|
|
[dl.deno.land](https://console.cloud.google.com/storage/browser/dl.deno.land/release/v$VERSION).
|
|
|
|
- [ ] Publish the release on Github
|
|
|
|
- [ ] Run
|
|
https://github.com/denoland/dotcom/actions/workflows/update_version.yml to
|
|
automatically open a PR.
|
|
- [ ] Merge the PR.
|
|
|
|
- [ ] Run
|
|
https://github.com/denoland/deno-docs/actions/workflows/update_versions.yml
|
|
to automatically open a PR.
|
|
- [ ] Merge the PR.
|
|
|
|
- [ ] For minor releases: make sure https://github.com/mdn/browser-compat-data
|
|
has been updated to reflect Web API changes in this release. Usually done
|
|
ahead of time by @lucacasonato.
|
|
|
|
- [ ] **If you are cutting a patch release**: a PR should have been
|
|
automatically opened that forwards the release commit back to main. If so,
|
|
merge it. If not and it failed, please manually create one.
|
|
|
|
## Updating `deno_docker`
|
|
|
|
- [ ] Run the version bump workflow:
|
|
https://github.com/denoland/deno_docker/actions/workflows/version_bump.yml
|
|
- [ ] This will open a PR. Review and merge it.
|
|
- [ ] Create a `$VERSION` tag (_without_ `v` prefix).
|
|
|
|
## All done!
|
|
|
|
- [ ] Write a message in company's #cli channel:
|
|
|
|
```
|
|
:unlock:
|
|
|
|
@here
|
|
|
|
`denoland/deno` is now unlocked.
|
|
|
|
*You can land PRs now*
|
|
|
|
Deno v$VERSION has been released.
|
|
```
|