From 019fe3c270b466f5c3fb8eadce6e7f53cb145f48 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Fri, 26 Feb 2021 15:45:58 -0700 Subject: [PATCH] docs(contributing): update updating vscode --- docs/CONTRIBUTING.md | 33 +++++++++++++++++++-------------- 1 file changed, 19 insertions(+), 14 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 67377ee2..426c28fb 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -2,14 +2,16 @@ # Contributing -- [Pull Requests](#pull-requests) -- [Requirements](#requirements) -- [Development Workflow](#development-workflow) - - [Updating VS Code](#updating-vs-code) -- [Build](#build) -- [Structure](#structure) - - [Modifications to VS Code](#modifications-to-vs-code) - - [Currently Known Issues](#currently-known-issues) +- [Contributing](#contributing) + - [Pull Requests](#pull-requests) + - [Requirements](#requirements) + - [Development Workflow](#development-workflow) + - [Updating VS Code](#updating-vs-code) + - [Notes about Changes](#notes-about-changes) + - [Build](#build) + - [Structure](#structure) + - [Modifications to VS Code](#modifications-to-vs-code) + - [Currently Known Issues](#currently-known-issues) @@ -59,14 +61,17 @@ To develop inside an isolated Docker container: ### Updating VS Code -If you need to update VS Code, you can update the subtree with one line. Here's an example using the version 1.52: +To update VS Code, follow these steps: +1. Run `yarn update:vscode`. +2. Enter a version. Ex. 1.53 +3. This will open a draft PR for you. +4. There will be merge conflicts. First commit them. + 1. We do this because if we don't, it will be impossible to review your PR. +5. Once they're all fixed, test code-server locally and make sure it all works. -```shell -# Add vscode as a new remote if you haven't already and fetch -git remote add -f vscode https://github.com/microsoft/vscode.git +#### Notes about Changes -git subtree pull --prefix lib/vscode vscode release/1.52 --squash --message "Update VS Code to 1.52" -``` +- watch out for updates to `lib/vscode/src/vs/code/browser/workbench/workbench.html`. You may need to make changes to `src/browser/pages/vscode.html` ## Build