You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* docs(CONTRIBUTING): update workflow based on vscode changes
* docs(MAINTAINING): add section for syncing VS Code upstream
Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
3.`cd vscode && git checkout code-server-v2` - checkout the branch we use (not the default)
88
-
4.`cd vscode && yarn install` - install the dependencies in the `vscode` repo
89
-
5.`cd code-server && yarn install` - install the dependencies in the `code-server` repo
90
-
6.`cd vscode && yarn link` - use `yarn` to create a symlink to the `vscode` repo (`code-oss-dev` package)
91
-
7.`cd code-server && yarn link code-oss-dev --modules-folder vendor/modules` - links your local `vscode` repo (`code-oss-dev` package) inside your local version of code-server
92
-
8.`cd code-server && yarn watch` - this will spin up code-server on localhost:8080 which you can start developing. It will live reload changes to the source.
87
+
3.`cd vscode && yarn install` - install the dependencies in the `vscode` repo
88
+
4.`cd code-server && yarn install` - install the dependencies in the `code-server` repo
89
+
5.`cd vscode && yarn link` - use `yarn` to create a symlink to the `vscode` repo (`code-oss-dev` package)
90
+
6.`cd code-server && yarn link code-oss-dev --modules-folder vendor/modules` - links your local `vscode` repo (`code-oss-dev` package) inside your local version of code-server
91
+
7.`cd code-server && yarn watch` - this will spin up code-server on localhost:8080 which you can start developing. It will live reload changes to the source.
93
92
94
93
### Updates to VS Code
95
94
96
-
If changes are made and merged into `code-server-v2` in the `cdr/vscode` repo, then you'll need to update the version in the `code-server` repo by following these steps:
95
+
If changes are made and merged into `main` in the [`cdr/vscode`](https://github.com/cdr/vscode) repo, then you'll need to update the version in the `code-server` repo by following these steps:
97
96
98
97
1. Update the package tag listed in `vendor/package.json`:
99
98
100
99
```json
101
100
{
102
101
"devDependencies": {
103
-
"vscode": "cdr/vscode#X.XX.X-code-server"
102
+
"vscode": "cdr/vscode#<latest-commit-sha>"
104
103
}
105
104
}
106
105
```
107
106
108
-
1. From the code-server **project root**, run `yarn install`.
107
+
2. From the code-server **project root**, run `yarn install`.
109
108
Then, test code-server locally to make sure everything works.
110
-
1. Check the Node.js version that's used by Electron (which is shipped with VS
109
+
3. Check the Node.js version that's used by Electron (which is shipped with VS
111
110
Code. If necessary, update your version of Node.js to match.
112
-
1. Open a PR
111
+
4. Open a PR
113
112
114
113
> Watch for updates to
115
114
> `vendor/modules/code-oss-dev/src/vs/code/browser/workbench/workbench.html`. You may need to
Copy file name to clipboardExpand all lines: docs/MAINTAINING.md
+14-2
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,7 @@
19
19
-[Docker](#docker)
20
20
-[Homebrew](#homebrew)
21
21
-[npm](#npm)
22
+
-[Syncing with Upstream VS Code](#syncing-with-upstream-vs-code)
22
23
-[Testing](#testing)
23
24
-[Documentation](#documentation)
24
25
-[Troubleshooting](#troubleshooting)
@@ -126,8 +127,7 @@ the issue.
126
127
127
128
### Merge strategies
128
129
129
-
For most things, we recommend the **squash and merge** strategy. If you're
130
-
updating `lib/vscode`, we suggest using the **rebase and merge** strategy. There
130
+
For most things, we recommend the **squash and merge** strategy. There
131
131
may be times where **creating a merge commit** makes sense as well. Use your
132
132
best judgment. If you're unsure, you can always discuss in the PR with the team.
133
133
@@ -215,6 +215,18 @@ We publish code-server as a npm package [here](https://www.npmjs.com/package/cod
215
215
216
216
This is currently automated with the release process.
217
217
218
+
## Syncing with Upstream VS Code
219
+
220
+
The VS Code portion of code-server lives under [`cdr/vscode`](https://github.com/cdr/vscode). To update VS Code for code-server, follow these steps:
221
+
222
+
1.`git checkout -b vscode-update` - Create a new branch locally based off `main`
4. Open a PR merging your branch (`vscode-update`) into `main` and add the code-server review team
227
+
228
+
Ideally, our fork stays as close to upstream as possible. See the differences between our fork and upstream [here](https://github.com/microsoft/vscode/compare/main...cdr:main).
229
+
218
230
## Testing
219
231
220
232
Our testing structure is laid out under our [Contributing docs](https://coder.com/docs/code-server/latest/CONTRIBUTING#test).
0 commit comments