From fbd6dace8e5c9be5fdd760c4ee304c4754b9ffb7 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/2] Pasted "Publishing A Release" in the '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 3755acc5bf38..b3e8cb0daa7c 100644 --- a/docs/MAINTAINING.md +++ b/docs/MAINTAINING.md @@ -79,6 +79,7 @@ If a PR does fix an issue, don't add it to the version milestone. Otherwise, the 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. 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. + ## Release ### Release Manager Rotation @@ -90,3 +91,26 @@ 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 24f329425e5f3e0b9e6c7113f593e76095d86eb4 Mon Sep 17 00:00:00 2001 From: Prashant168 <61613428+Prashant168@users.noreply.github.com> Date: Sat, 29 May 2021 23:56:56 +0530 Subject: [PATCH 2/2] Update MAINTAINING.md Deleted the extra line, hoping it will solve the issue. --- docs/MAINTAINING.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/MAINTAINING.md b/docs/MAINTAINING.md index b3e8cb0daa7c..2c78fe6e26f1 100644 --- a/docs/MAINTAINING.md +++ b/docs/MAINTAINING.md @@ -79,7 +79,6 @@ If a PR does fix an issue, don't add it to the version milestone. Otherwise, the 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. 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. - ## Release ### Release Manager Rotation @@ -92,7 +91,6 @@ 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 1. Run `yarn release:prep` and type in the new version i.e. 3.8.1