Skip to content

Commit e02ecc2

Browse files
Prashant168jsjoeio
authored andcommitted
docs: add "Publishing A Release" in 'MAINTAINING.md' file
Pasted "Publishing A Release" in the 'MAINTAINING.md' file from line #98
1 parent 54aea3f commit e02ecc2

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

docs/MAINTAINING.md

+24
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
# Maintaining
44

55
- [Maintaining](#maintaining)
6+
- [Maintaining](#maintaining-1)
67
- [Workflow](#workflow)
78
- [Milestones](#milestones)
89
- [Triage](#triage)
@@ -13,6 +14,7 @@
1314
- [Changelog](#changelog)
1415
- [Release](#release)
1516
- [Release Manager Rotation](#release-manager-rotation)
17+
- [Publishing a release](#publishing-a-release)
1618

1719
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
1820

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

0 commit comments

Comments
 (0)