Skip to content

Commit e391f68

Browse files
committed
docs: update workflow and remove yarn vscode
1 parent 5830532 commit e391f68

File tree

2 files changed

+12
-29
lines changed

2 files changed

+12
-29
lines changed

ci/README.md

-9
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,6 @@ This directory contains scripts used for the development of code-server.
5555
- Runs tests.
5656
- [./ci/dev/ci.sh](./dev/ci.sh) (`yarn ci`)
5757
- Runs `yarn fmt`, `yarn lint` and `yarn test`.
58-
- [./ci/dev/vscode.sh](./dev/vscode.sh) (`yarn vscode`)
59-
- Ensures [./lib/vscode](../lib/vscode) is cloned, patched and dependencies are installed.
60-
- [./ci/dev/patch-vscode.sh](./dev/patch-vscode.sh) (`yarn vscode:patch`)
61-
- Applies [./ci/dev/vscode.patch](./dev/vscode.patch) to [./lib/vscode](../lib/vscode).
62-
- [./ci/dev/diff-vscode.sh](./dev/diff-vscode.sh) (`yarn vscode:diff`)
63-
- Diffs [./lib/vscode](../lib/vscode) into [./ci/dev/vscode.patch](./dev/vscode.patch).
64-
- [./ci/dev/vscode.patch](./dev/vscode.patch)
65-
- Our patch of VS Code, see [./doc/CONTRIBUTING.md](../doc/CONTRIBUTING.md#vs-code-patch).
66-
- Generate it with `yarn vscode:diff` and apply with `yarn vscode:patch`.
6758
- [./ci/dev/watch.ts](./dev/watch.ts) (`yarn watch`)
6859
- Starts a process to build and launch code-server and restart on any code changes.
6960
- Example usage in [./doc/CONTRIBUTING.md](../doc/CONTRIBUTING.md).

doc/CONTRIBUTING.md

+12-20
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,14 @@
22
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
33
# Contributing
44

5-
- [Pull Requests](#pull-requests)
6-
- [Requirements](#requirements)
7-
- [Development Workflow](#development-workflow)
8-
- [Build](#build)
9-
- [Structure](#structure)
10-
- [VS Code Patch](#vs-code-patch)
11-
- [Currently Known Issues](#currently-known-issues)
5+
- [Contributing](#contributing)
6+
- [Pull Requests](#pull-requests)
7+
- [Requirements](#requirements)
8+
- [Development Workflow](#development-workflow)
9+
- [Build](#build)
10+
- [Structure](#structure)
11+
- [VS Code Patch](#vs-code-patch)
12+
- [Currently Known Issues](#currently-known-issues)
1213

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

@@ -42,7 +43,6 @@ of the dependencies code-server uses.
4243

4344
```shell
4445
yarn
45-
yarn vscode
4646
yarn watch
4747
# Visit http://localhost:8080 once the build is completed.
4848
```
@@ -51,15 +51,11 @@ To develop inside an isolated Docker container:
5151

5252
```shell
5353
./ci/dev/image/run.sh yarn
54-
./ci/dev/image/run.sh yarn vscode
5554
./ci/dev/image/run.sh yarn watch
5655
```
5756

5857
`yarn watch` will live reload changes to the source.
5958

60-
If you introduce changes to the patch and you've previously built, you
61-
must (1) manually reset VS Code and (2) run `yarn vscode:patch`.
62-
6359
## Build
6460

6561
You can build using:
@@ -89,7 +85,6 @@ The `release.sh` script is equal to running:
8985

9086
```shell
9187
yarn
92-
yarn vscode
9388
yarn build
9489
yarn build:vscode
9590
yarn release
@@ -117,7 +112,7 @@ The `code-server` script serves an HTTP API for login and starting a remote VS C
117112
The CLI code is in [./src/node](./src/node) and the HTTP routes are implemented in
118113
[./src/node/app](./src/node/app).
119114

120-
Most of the meaty parts are in the VS Code patch, which we described next.
115+
Most of the meaty parts are in the VS Code portion of the codebase under [./lib/vscode](./lib/vscode), which we described next.
121116

122117
### VS Code Patch
123118

@@ -127,10 +122,9 @@ and exposed an API to the front-end for file access and all UI needs.
127122

128123
Over time, Microsoft added support to VS Code to run it on the web. They have made
129124
the front-end open source, but not the server. As such, code-server v2 (and later) uses
130-
the VS Code front-end and implements the server. You can find this in
131-
[./ci/dev/vscode.patch](../ci/dev/vscode.patch) under the path `src/vs/server`.
125+
the VS Code front-end and implements the server. We use a git subtree to be able to pull in VS Code's front-end. This code lives under [./lib/vscode](./lib/vscode).
132126

133-
Other notable changes in our patch include:
127+
Some noteworthy changes in our codebase:
134128

135129
- Adding our build file, which includes our code and VS Code's web code
136130
- Allowing multiple extension directories (both user and built-in)
@@ -146,12 +140,10 @@ Other notable changes in our patch include:
146140

147141
As the web portion of VS Code matures, we'll be able to shrink and possibly
148142
eliminate our patch. In the meantime, upgrading the VS Code version requires
149-
us to ensure that the patch is applied and works as intended. In the future,
143+
us to ensure that our changes are applied and work as intended. In the future,
150144
we'd like to run VS Code unit tests against our builds to ensure that features
151145
work as expected.
152146

153-
To generate a new patch, run `yarn vscode:diff`
154-
155147
**Note**: We have [extension docs](../ci/README.md) on the CI and build system.
156148

157149
If the functionality you're working on does NOT depend on code from VS Code, please

0 commit comments

Comments
 (0)