From e02ecc2c8046d7f6517dc50a1373b308027f4fc7 Mon Sep 17 00:00:00 2001 From: Prashant168 <61613428+Prashant168@users.noreply.github.com> Date: Tue, 25 May 2021 20:18:01 +0530 Subject: [PATCH 1/4] docs: add "Publishing A Release" in 'MAINTAINING.md' file Pasted "Publishing A Release" in the 'MAINTAINING.md' file from line #98 --- docs/MAINTAINING.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/MAINTAINING.md b/docs/MAINTAINING.md index fb723bc85..f7bcce730 100644 --- a/docs/MAINTAINING.md +++ b/docs/MAINTAINING.md @@ -3,6 +3,7 @@ # Maintaining - [Maintaining](#maintaining) +- [Maintaining](#maintaining-1) - [Workflow](#workflow) - [Milestones](#milestones) - [Triage](#triage) @@ -13,6 +14,7 @@ - [Changelog](#changelog) - [Release](#release) - [Release Manager Rotation](#release-manager-rotation) + - [Publishing a release](#publishing-a-release) @@ -99,3 +101,25 @@ If you're the current release manager, follow these steps: 1. Create a [release issue](../.github/ISSUE_TEMPLATE/release.md) 2. Fill out checklist 3. After release is published, close release milestone + +## Publishing a release + +1. Run `yarn release:prep` and type in the new version i.e. 3.8.1 +2. GitHub actions will generate the `npm-package`, `release-packages` and `release-images` artifacts. + 1. You do not have to wait for these. +3. Run `yarn release:github-draft` to create a GitHub draft release from the template with + the updated version. + 1. Summarize the major changes in the release notes and link to the relevant issues. + 2. Change the @ to target the version branch. Example: `v3.9.0 @ Target: v3.9.0` +4. Wait for the artifacts in step 2 to build. +5. Run `yarn release:github-assets` to download the `release-packages` artifact. + - It will upload them to the draft release. +6. Run some basic sanity tests on one of the released packages. + - Especially make sure the terminal works fine. +7. Publish the release and merge the PR. + 1. CI will automatically grab the artifacts and then: + 1. Publish the NPM package from `npm-package`. + 2. Publish the Docker Hub image from `release-images`. +8. Update the AUR package. + - Instructions on updating the AUR package are at [cdr/code-server-aur](https://github.com/cdr/code-server-aur). +9. Wait for the npm package to be published. From 7dfd3676c163d10c29c5dd1a05268881d983968b Mon Sep 17 00:00:00 2001 From: Prashant168 <61613428+Prashant168@users.noreply.github.com> Date: Tue, 25 May 2021 20:13:52 +0530 Subject: [PATCH 2/4] docs: remove "Publishing A Release" from ci/README.md Deleted "Publishing A Release" section from the readme.md file in the 'ci' folder and then pasting the section in 'Maintaining.md' --- ci/README.md | 21 --------------------- 1 file changed, 21 deletions(-) diff --git a/ci/README.md b/ci/README.md index be14aa8fc..ee3380a77 100644 --- a/ci/README.md +++ b/ci/README.md @@ -10,27 +10,6 @@ Any file or directory in this subdirectory should be documented here. - [./ci/lib.sh](./lib.sh) - Contains code duplicated across these scripts. -## Publishing a release - -1. Run `yarn release:prep` and type in the new version i.e. 3.8.1 -2. GitHub actions will generate the `npm-package`, `release-packages` and `release-images` artifacts. - 1. You do not have to wait for these. -3. Run `yarn release:github-draft` to create a GitHub draft release from the template with - the updated version. - 1. Summarize the major changes in the release notes and link to the relevant issues. - 2. Change the @ to target the version branch. Example: `v3.9.0 @ Target: v3.9.0` -4. Wait for the artifacts in step 2 to build. -5. Run `yarn release:github-assets` to download the `release-packages` artifact. - - It will upload them to the draft release. -6. Run some basic sanity tests on one of the released packages. - - Especially make sure the terminal works fine. -7. Publish the release and merge the PR. - 1. CI will automatically grab the artifacts and then: - 1. Publish the NPM package from `npm-package`. - 2. Publish the Docker Hub image from `release-images`. -8. Update the AUR package. - - Instructions on updating the AUR package are at [cdr/code-server-aur](https://github.com/cdr/code-server-aur). -9. Wait for the npm package to be published. ## dev From 857c62ae1d3d35752ebd92ccb88eeda44177b0bc Mon Sep 17 00:00:00 2001 From: Akash Satheesan Date: Mon, 31 May 2021 20:39:31 +0530 Subject: [PATCH 3/4] chore: yarn fmt + changelog --- CHANGELOG.md | 1 + ci/README.md | 1 - 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9163e909a..ca8939aff 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -51,6 +51,7 @@ VS Code v0.00.0 - docs: fix confusing sentence in pull requests section #3460 @shiv-tyagi - docs: remove toc from changelog @oxy @jsjoeio - docs(MAINTAINING): add information about CHANGELOG #3467 @jsjoeio +- docs: move release process to MAINTAINING.md #3441 @oxy @Prashant168 ### Development diff --git a/ci/README.md b/ci/README.md index ee3380a77..f92de0a76 100644 --- a/ci/README.md +++ b/ci/README.md @@ -10,7 +10,6 @@ Any file or directory in this subdirectory should be documented here. - [./ci/lib.sh](./lib.sh) - Contains code duplicated across these scripts. - ## dev This directory contains scripts used for the development of code-server. From 30a312df290fc4ae8578dad137013f2ae2b34b7a Mon Sep 17 00:00:00 2001 From: Akash Satheesan Date: Mon, 31 May 2021 20:41:58 +0530 Subject: [PATCH 4/4] docs: change header depth --- docs/MAINTAINING.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/MAINTAINING.md b/docs/MAINTAINING.md index f7bcce730..c56e5b334 100644 --- a/docs/MAINTAINING.md +++ b/docs/MAINTAINING.md @@ -3,7 +3,6 @@ # Maintaining - [Maintaining](#maintaining) -- [Maintaining](#maintaining-1) - [Workflow](#workflow) - [Milestones](#milestones) - [Triage](#triage) @@ -14,7 +13,7 @@ - [Changelog](#changelog) - [Release](#release) - [Release Manager Rotation](#release-manager-rotation) - - [Publishing a release](#publishing-a-release) + - [Publishing a release](#publishing-a-release) @@ -102,7 +101,7 @@ If you're the current release manager, follow these steps: 2. Fill out checklist 3. After release is published, close release milestone -## Publishing a release +### Publishing a release 1. Run `yarn release:prep` and type in the new version i.e. 3.8.1 2. GitHub actions will generate the `npm-package`, `release-packages` and `release-images` artifacts.