Skip to content

Commit 33f7f94

Browse files
JosephTLyonsFrGoIs
authored andcommitted
Update Wednesday release process docs (zed-industries#37033)
Release Notes: - N/A
1 parent 385786e commit 33f7f94

File tree

1 file changed

+49
-13
lines changed

1 file changed

+49
-13
lines changed

docs/src/development/releases.md

Lines changed: 49 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,56 @@ Read about Zed's release channels [here](https://zed.dev/faq#what-are-the-releas
44

55
## Wednesday release process
66

7-
You will need write access to the Zed repository to do this:
7+
You will need write access to the Zed repository to do this.
88

9-
- Checkout `main` and ensure your working copy is clean.
10-
- Run `./script/bump-zed-minor-versions` and push the tags
11-
and branches as instructed.
12-
- Wait for the builds to appear on [the Releases tab on GitHub](https://github.com/zed-industries/zed/releases) (typically takes around 30 minutes)
13-
- While you're waiting:
14-
- Start creating the new release notes for preview. You can start with the output of `./script/get-preview-channel-changes`.
15-
- Start drafting the release tweets.
16-
- Once the builds are ready:
17-
- Copy the release notes from the previous Preview release(s) to the current Stable release.
18-
- Download the artifacts for each release and test that you can run them locally.
19-
- Publish the releases on GitHub.
20-
- Tweet the tweets (Credentials are in 1Password).
9+
Credentials for various services used in this process can be found in 1Password.
10+
11+
---
12+
13+
1. Checkout `main` and ensure your working copy is clean.
14+
15+
1. Run `git fetch && git pull` to ensure you have the latest commits locally.
16+
17+
1. Run `git fetch --tags --force` to forcibly ensure your local tags are in sync with the remote.
18+
19+
1. Run `./script/get-stable-channel-release-notes`.
20+
21+
- Follow the instructions at the end of the script and aggregate the release notes into one structure.
22+
23+
1. Run `./script/bump-zed-minor-versions`.
24+
25+
- Push the tags and branches as instructed.
26+
27+
1. Run `./script/get-preview-channel-changes`.
28+
29+
- Take the script's output and build release notes by organizing each release note line into a category.
30+
- Use a prior release for the initial outline.
31+
- Make sure to append the `Credit` line, if present, to the end of the release note line.
32+
33+
1. Once release drafts are up on [GitHub Releases](https://github.com/zed-industries/zed/releases), paste both preview and stable release notes into each and **save**.
34+
35+
- **Do not publish the drafts, yet.**
36+
37+
1. Check the release assets.
38+
39+
- Ensure the stable and preview release jobs have finished without error.
40+
- Ensure each build has the proper number of assets—releases currently have 10 assets each.
41+
- Download the artifacts for each release and test that you can run them locally.
42+
43+
1. Publish each build, one at a time.
44+
45+
- Use [Vercel](https://vercel.com/zed-industries/zed-dev) to check the status of each build.
46+
47+
1. Publish the release email that has been sent to [Kit](https://kit.com).
48+
49+
- Make sure to double check that the email is correct before publishing.
50+
- We sometimes correct things here and there that didn't translate from GitHub's renderer to Kit's.
51+
52+
1. Build social media posts based on the popular items in stable.
53+
54+
- You can use the [prior week's post chain](https://zed.dev/channel/tweets-23331) as your outline.
55+
- Stage the copy and assets using [Buffer](https://buffer.com), for both X and BlueSky.
56+
- Publish both, one at a time, ensuring both are posted to each respective platform.
2157

2258
## Patch release process
2359

0 commit comments

Comments
 (0)