Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(tools): update release template #23582

Merged
merged 1 commit into from
Apr 28, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
chore(tools): update release template
  • Loading branch information
kt3k committed Apr 27, 2024
commit 40049d65a9d336689abde02bfbb6d6ef8f913452
48 changes: 3 additions & 45 deletions tools/release/release_doc_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

- Forks and local clones of
[`denoland/deno`](https://github.com/denoland/deno/),
[`denoland/deno_std`](https://github.com/denoland/deno_std/),
[`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)
Expand All @@ -16,7 +15,7 @@ cut.**
- [ ] Check https://deno.land/benchmarks?-100 and ensure there's no recent
regressions.
- [ ] Write a message in company's #cli channel:
`:lock: deno and deno_std are now locked (<LINK TO THIS FORKED GIST GOES HERE>)`
`:lock: deno is now locked (<LINK TO THIS FORKED GIST GOES HERE>)`

## Patch release preparation

Expand All @@ -41,42 +40,6 @@ verify on GitHub that everything looks correct.
- [ ] Unstable `feat` commits were merged.
- [ ] Internal API commits like `feat(core)` were merged.

## Updating `deno_std`

- [ ] Go to the "version_bump" workflow in the deno_std repo's actions:
https://github.com/denoland/deno_std/actions/workflows/version_bump.yml
1. Click on the "Run workflow" button.
1. For the kind of release, select "minor".
1. Run the workflow.

- [ ] A PR will be automatically created. Follow the checklist in the PR, review
it, and merge the PR.
- ⛔ DO NOT create a release tag manually. That will automatically happen.

<details>
<summary>Failure Steps</summary>

1. Checkout the latest main.
2. Manually run `./_tools/release/01_bump_version.ts --minor`
1. Ensure the version in `version.ts` is updated correctly.
2. Ensure `Releases.md` is updated correctly.
3. Ensure all the tests pass with the latest build (examine the repo for
what the command is and run the local built deno binary)
3. Open a PR with the changes and continue with the steps below.
</details>

- Wait for the CI run to complete which will automatically tag the repo and
create a draft release.
- [ ] Review the draft release and then publish it.

<details>
<summary>Failure Steps</summary>

1. Tag the repo manually in the format `x.x.x`
2. Draft a new GH release by copying and pasting the release notes from
`Releases.md`
</details>

## Updating `deno`

### Phase 1: Bumping versions
Expand Down Expand Up @@ -154,7 +117,7 @@ verify on GitHub that everything looks correct.
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.land/api` & `deno.land/std` symbols
## Updating `deno.land/api` symbols

This should occur after the Deno CLI & std are fully published, as the build
script generates the symbols based on the latest tags.
Expand All @@ -163,17 +126,12 @@ script generates the symbols based on the latest tags.
branch:
https://github.com/denoland/apiland_scripts/actions/workflows/release_cli.yml
- [ ] Verify the workflow ran successfully.
- [ ] Run the `release STD` workflow in the apiland_scripts repo on the main
branch:
https://github.com/denoland/apiland_scripts/actions/workflows/release_std.yml
- [ ] Verify the workflow ran successfully.

<details>
<summary>Failure Steps</summary>

1. Clone `deno/apiland_scripts`.
2. Execute `deno task release:cli`.
3. Execute `deno task release:std`.
Copy link
Collaborator

@iuioiua iuioiua Apr 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should remove the release:std task if it's no longer used?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could need it in the future when we need to release deno.land/std for some reason (for example, for security fixes)

</details>

## Updating `deno_docker`
Expand All @@ -193,4 +151,4 @@ script generates the symbols based on the latest tags.
## All done!

- [ ] Write a message in company's #cli channel:
`:unlock: deno and deno_std are now unlocked`.
`:unlock: deno is now unlocked`.