docs: update sections around VS Code fork #4571
Conversation
jsjoeio
force-pushed
the
jsjoeio-update-docs
branch
from
fcd4764 to
2075f4b
Compare
| @@ -84,23 +84,22 @@ Here are these steps you should follow to get your dev environment setup: | |||
|
|
|||
| 1. `git clone https://github.com/cdr/code-server.git` - Clone `code-server` | |||
| 2. `git clone https://github.com/cdr/vscode.git` - Clone `vscode` | |||
| 3. `cd vscode && git checkout code-server-v2` - checkout the branch we use (not the default) | |||
| 4. `cd vscode && yarn install` - install the dependencies in the `vscode` repo | |||
| 5. `cd code-server && yarn install` - install the dependencies in the `code-server` repo | |||
There was a problem hiding this comment.
🧹 We're now using the main branch (instead of code-server-v2 so step 3 was removed.
|
|
||
| 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: | ||
|
|
||
| 1. `git checkout -b vscode-update` - Create a new branch locally based off `main` |
There was a problem hiding this comment.
❓ Is this the best approach?
Originally @TeffenEllis suggested going to the GitHub UI and hitting "fetch upstream." From a dev's perspective, that makes it super easy! The downside to that approach is there may be merge conflicts to resolve locally. If there are, they can't be reviewed by another developer.
Thoughts @code-asher?
There was a problem hiding this comment.
I like this approach. We will likely keep having conflicts for a while (we already currently have conflicts with upstream).
|
✨ Coder.com for PR #4571 deployed! It will be updated on every commit.
|
Codecov Report
@@ Coverage Diff @@
## main #4571 +/- ##
=======================================
Coverage 65.52% 65.52%
=======================================
Files 30 30
Lines 1665 1665
Branches 334 334
=======================================
Hits 1091 1091
Misses 485 485
Partials 89 89 Continue to review full report at Codecov.
|
|
|
||
| ### Updates to VS Code | ||
|
|
||
| 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: | ||
| 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: | ||
|
|
||
| 1. Update the package tag listed in `vendor/package.json`: |
There was a problem hiding this comment.
This was not introduced in your PR but it looks like the following steps begin at 1 again:
https://github.com/cdr/code-server/blob/2075f4bd5a24dd461925559f80851dd16ba508c2/docs/CONTRIBUTING.md#updates-to-vs-code
It seems the auto-numbering cannot take into account breaks like the code block here. Another reason to avoid them I suppose 😄
There was a problem hiding this comment.
Oh dang it! lol i'll see if I can fix that
jsjoeio
force-pushed
the
jsjoeio-update-docs
branch
from
2075f4b to
af646d2
Compare
This PR updates our docs around the VS Code fork and syncing with upstream.
Fixes #4533