Skip to content

Commit fbd6dac

Browse files
authored
Pasted "Publishing A Release" in the 'MAINTAINING.md' file
Pasted "Publishing A Release" in the 'MAINTAINING.md' file from line #98
1 parent dc81786 commit fbd6dac

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

docs/MAINTAINING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ If a PR does fix an issue, don't add it to the version milestone. Otherwise, the
7979
For most things, we recommend "Squash and Merge". If you're updating `lib/vscode`, we suggest using the "Rebase and Merge" strategy. There may be times where "Create a merge commit" makes sense as well. Use your best judgement. If you're unsure, you can always discuss in the PR with the team.
8080
The code-server project follows traditional [semantic versioning](ttps://semver.org/), with the objective of minimizing major changes that break backward compatibility. We increment the patch level for all releases, except when the upstream Visual Studio Code project increments its minor version or we change the plugin API in a backward-compatible manner. In those cases, we increment the minor version rather than the patch level.
8181

82+
8283
## Release
8384

8485
### Release Manager Rotation
@@ -90,3 +91,26 @@ If you're the current release manager, follow these steps:
9091
1. Create a [release issue](../.github/ISSUE_TEMPLATE/release.md)
9192
2. Fill out checklist
9293
3. After release is published, close release milestone
94+
95+
96+
## Publishing a release
97+
98+
1. Run `yarn release:prep` and type in the new version i.e. 3.8.1
99+
2. GitHub actions will generate the `npm-package`, `release-packages` and `release-images` artifacts.
100+
1. You do not have to wait for these.
101+
3. Run `yarn release:github-draft` to create a GitHub draft release from the template with
102+
the updated version.
103+
1. Summarize the major changes in the release notes and link to the relevant issues.
104+
2. Change the @ to target the version branch. Example: `v3.9.0 @ Target: v3.9.0`
105+
4. Wait for the artifacts in step 2 to build.
106+
5. Run `yarn release:github-assets` to download the `release-packages` artifact.
107+
- It will upload them to the draft release.
108+
6. Run some basic sanity tests on one of the released packages.
109+
- Especially make sure the terminal works fine.
110+
7. Publish the release and merge the PR.
111+
1. CI will automatically grab the artifacts and then:
112+
1. Publish the NPM package from `npm-package`.
113+
2. Publish the Docker Hub image from `release-images`.
114+
8. Update the AUR package.
115+
- Instructions on updating the AUR package are at [cdr/code-server-aur](https://github.com/cdr/code-server-aur).
116+
9. Wait for the npm package to be published.

0 commit comments

Comments
 (0)