oak-team/oak-gpui
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update patch and nightly release docs (#37109)

Browse Source 
Release Notes:

- N/A
This commit is contained in:
Joseph T. Lyons
2025-08-28 18:49:03 +00:00
committed by GitHub
parent 27777d4b8f
commit 909d7215c0
1 changed files with 39 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/src/development/releases.md
+39 -17
View File
@@ -37,16 +37,17 @@ Credentials for various services used in this process can be found in 1Password.
1. Check the release assets.
- Ensure the stable and preview release jobs have finished without error.
- Ensure each build has the proper number of assets—releases currently have 10 assets each.
- Download the artifacts for each release and test that you can run them locally.
- Ensure each draft has the proper number of assets—releases currently have 10 assets each.
- Download the artifacts for each release draft and test that you can run them locally.
1. Publish each build, one at a time.
1. Publish stable / preview drafts, one at a time.
- Use [Vercel](https://vercel.com/zed-industries/zed-dev) to check the status of each build.
- Use [Vercel](https://vercel.com/zed-industries/zed-dev) to check the progress of the website rebuild.
The release will be public once the rebuild has completed.
1. Publish the release email that has been sent to [Kit](https://kit.com).
- Make sure to double check that the email is correct before publishing.
- Make sure to double-check that the email is correct before publishing.
- We sometimes correct things here and there that didn't translate from GitHub's renderer to Kit's.
1. Build social media posts based on the popular items in stable.
@@ -57,22 +58,43 @@ Credentials for various services used in this process can be found in 1Password.
## Patch release process
If your PR fixes a panic or a crash, you should cherry-pick it to the current stable and preview branches. If your PR fixes a regression in recently released code, you should cherry-pick it to preview.
If your PR fixes a panic or a crash, you should cherry-pick it to the current stable and preview branches.
If your PR fixes a regression in recently released code, you should cherry-pick it to preview.
You will need write access to the Zed repository to do this:
- Send a PR containing your change to `main` as normal.
- Leave a comment on the PR `/cherry-pick v0.XXX.x`. Once your PR is merged, the GitHub bot will send a PR to the branch.
- In case of a merge conflict, you will have to cherry-pick manually and push the change to the `v0.XXX.x` branch.
- After the commits are cherry-picked onto the branch, run `./script/trigger-release {preview|stable}`. This will bump the version numbers, create a new release tag, and kick off a release build.
- This can also be run from the [GitHub Actions UI](https://github.com/zed-industries/zed/actions/workflows/bump_patch_version.yml):
![](https://github.com/zed-industries/zed/assets/1486634/9e31ae95-09e1-4c7f-9591-944f4f5b63ea)
- Wait for the builds to appear on [the Releases tab on GitHub](https://github.com/zed-industries/zed/releases) (typically takes around 30 minutes)
- Proof-read and edit the release notes as needed.
- Download the artifacts for each release and test that you can run them locally.
- Publish the release.
---
1. Send a PR containing your change to `main` as normal.
1. Once it is merged, cherry-pick the commit locally to either of the release branches (`v0.XXX.x`).
- In some cases, you may have to handle a merge conflict.
More often than not, this will happen when cherry-picking to stable, as the stable branch is more "stale" than the preview branch.
1. After the commit is cherry-picked, run `./script/trigger-release {preview|stable}`.
This will bump the version numbers, create a new release tag, and kick off a release build.
- This can also be run from the [GitHub Actions UI](https://github.com/zed-industries/zed/actions/workflows/bump_patch_version.yml):
![](https://github.com/zed-industries/zed/assets/1486634/9e31ae95-09e1-4c7f-9591-944f4f5b63ea)
1. Once release drafts are up on [GitHub Releases](https://github.com/zed-industries/zed/releases), proofread and edit the release notes as needed and **save**.
- **Do not publish the drafts, yet.**
1. Check the release assets.
- Ensure the stable / preview release jobs have finished without error.
- Ensure each draft has the proper number of assets—releases currently have 10 assets each.
- Download the artifacts for each release draft and test that you can run them locally.
1. Publish stable / preview drafts, one at a time.
- Use [Vercel](https://vercel.com/zed-industries/zed-dev) to check the progress of the website rebuild.
The release will be public once the rebuild has completed.
## Nightly release process
In addition to the public releases, we also have a nightly build that we encourage employees to use.
Nightly is released by cron once a day, and can be shipped as often as you'd like. There are no release notes or announcements, so you can just merge your changes to main and run `./script/trigger-release nightly`.
Nightly is released by cron once a day, and can be shipped as often as you'd like.
There are no release notes or announcements, so you can just merge your changes to main and run `./script/trigger-release nightly`.