Skip to content

Commit 40ef0f2

Browse files
authored
Merge pull request #3512 from cdr/oxy/release-doc-fixup
docs: move release process to MAINTAINING.md
2 parents 54aea3f + 30a312d commit 40ef0f2

File tree

3 files changed

+24
-22
lines changed

3 files changed

+24
-22
lines changed

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ VS Code v0.00.0
5151
- docs: fix confusing sentence in pull requests section #3460 @shiv-tyagi
5252
- docs: remove toc from changelog @oxy @jsjoeio
5353
- docs(MAINTAINING): add information about CHANGELOG #3467 @jsjoeio
54+
- docs: move release process to MAINTAINING.md #3441 @oxy @Prashant168
5455

5556
### Development
5657

ci/README.md

-22
Original file line numberDiff line numberDiff line change
@@ -10,28 +10,6 @@ Any file or directory in this subdirectory should be documented here.
1010
- [./ci/lib.sh](./lib.sh)
1111
- Contains code duplicated across these scripts.
1212

13-
## Publishing a release
14-
15-
1. Run `yarn release:prep` and type in the new version i.e. 3.8.1
16-
2. GitHub actions will generate the `npm-package`, `release-packages` and `release-images` artifacts.
17-
1. You do not have to wait for these.
18-
3. Run `yarn release:github-draft` to create a GitHub draft release from the template with
19-
the updated version.
20-
1. Summarize the major changes in the release notes and link to the relevant issues.
21-
2. Change the @ to target the version branch. Example: `v3.9.0 @ Target: v3.9.0`
22-
4. Wait for the artifacts in step 2 to build.
23-
5. Run `yarn release:github-assets` to download the `release-packages` artifact.
24-
- It will upload them to the draft release.
25-
6. Run some basic sanity tests on one of the released packages.
26-
- Especially make sure the terminal works fine.
27-
7. Publish the release and merge the PR.
28-
1. CI will automatically grab the artifacts and then:
29-
1. Publish the NPM package from `npm-package`.
30-
2. Publish the Docker Hub image from `release-images`.
31-
8. Update the AUR package.
32-
- Instructions on updating the AUR package are at [cdr/code-server-aur](https://github.com/cdr/code-server-aur).
33-
9. Wait for the npm package to be published.
34-
3513
## dev
3614

3715
This directory contains scripts used for the development of code-server.

docs/MAINTAINING.md

+23
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
- [Changelog](#changelog)
1414
- [Release](#release)
1515
- [Release Manager Rotation](#release-manager-rotation)
16+
- [Publishing a release](#publishing-a-release)
1617

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

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

0 commit comments

Comments
 (0)