docs: update sections around VS Code fork #4571

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merged

repo-ranger merged 3 commits into main from jsjoeio-update-docs

Dec 6, 2021

Merged

docs: update sections around VS Code fork #4571

repo-ranger merged 3 commits into main from jsjoeio-update-docs

Dec 6, 2021

Conversation

jsjoeio

Copy link

Contributor

@jsjoeio jsjoeio commented Dec 1, 2021

This PR updates our docs around the VS Code fork and syncing with upstream.

Fixes #4533

@jsjoeio jsjoeio self-assigned this

Dec 1, 2021

@jsjoeio jsjoeio added the docs label

Dec 1, 2021

@jsjoeio jsjoeio force-pushed the jsjoeio-update-docs branch from fcd4764 to 2075f4b Compare

December 1, 2021 21:26

jsjoeio

jsjoeio commented

Dec 1, 2021

View reviewed changes

docs/CONTRIBUTING.md

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

Copy link

Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 We're now using the main branch (instead of code-server-v2 so step 3 was removed.

docs/MAINTAINING.md

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`

Copy link

Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❓ 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?

Copy link

Member

@code-asher code-asher Dec 2, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this approach. We will likely keep having conflicts for a while (we already currently have conflicts with upstream).

@jsjoeio jsjoeio marked this pull request as ready for review

December 1, 2021 21:29

@jsjoeio jsjoeio requested a review from a team as a code owner

December 1, 2021 21:29

@github-actions

Copy link

github-actions bot commented Dec 1, 2021 •

edited

Loading

✨ Coder.com for PR #4571 deployed! It will be updated on every commit.

Host: https://codercom-6h4rwzeqe-codercom.vercel.app/docs/code-server
Last deploy status: success
Commit: e6b3375
Workflow status: https://github.com/cdr/code-server/actions/runs/1545836602

@codecov

Copy link

codecov bot commented Dec 1, 2021 •

edited

Loading

Codecov Report

Merging #4571 (e6b3375) into main (80f30fc) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@ 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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 80f30fc...e6b3375. Read the comment docs.

code-asher

code-asher approved these changes

Dec 2, 2021

View reviewed changes

Copy link

Member

@code-asher code-asher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Beautiful!

docs/CONTRIBUTING.md

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`:

Copy link

Member

@code-asher code-asher Dec 2, 2021 •

edited

Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 😄

Copy link

Contributor Author

@jsjoeio jsjoeio Dec 6, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh dang it! lol i'll see if I can fix that

jsjoeio added 2 commits

December 6, 2021 10:23

@jsjoeio


 docs(CONTRIBUTING): update workflow based on vscode changes

26345e1

@jsjoeio


 docs(MAINTAINING): add section for syncing VS Code upstream

af646d2

@jsjoeio jsjoeio force-pushed the jsjoeio-update-docs branch from 2075f4b to af646d2 Compare

December 6, 2021 17:23

@jsjoeio jsjoeio added the squash when passing label

Dec 6, 2021

@repo-ranger


 Merge branch 'main' into jsjoeio-update-docs

e6b3375

@repo-ranger repo-ranger bot merged commit d15731a into main

Dec 6, 2021

@repo-ranger repo-ranger bot deleted the jsjoeio-update-docs branch

December 6, 2021 17:58

Labels

docs

2 participants

@jsjoeio @code-asher

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: update sections around VS Code fork #4571

docs: update sections around VS Code fork #4571

Uh oh!

Conversation

@jsjoeio jsjoeio commented Dec 1, 2021

Uh oh!

@jsjoeio jsjoeio Dec 1, 2021

Choose a reason for hiding this comment

Uh oh!

@jsjoeio jsjoeio Dec 1, 2021

Choose a reason for hiding this comment

Uh oh!

@code-asher code-asher Dec 2, 2021

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Dec 1, 2021 •

edited

Loading

Uh oh!

Uh oh!

codecov bot commented Dec 1, 2021 •

edited

Loading

Uh oh!

Codecov Report

Uh oh!

@code-asher code-asher left a comment

Choose a reason for hiding this comment

Uh oh!

@code-asher code-asher Dec 2, 2021 •

edited

Loading

Uh oh!

Choose a reason for hiding this comment

Uh oh!

@jsjoeio jsjoeio Dec 6, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

docs: update sections around VS Code fork #4571

docs: update sections around VS Code fork #4571

Uh oh!

Conversation

@jsjoeio jsjoeio commented Dec 1, 2021

Uh oh!

@jsjoeio jsjoeio Dec 1, 2021

Choose a reason for hiding this comment

Uh oh!

@jsjoeio jsjoeio Dec 1, 2021

Choose a reason for hiding this comment

Uh oh!

@code-asher code-asher Dec 2, 2021

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Dec 1, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Dec 1, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

@code-asher code-asher left a comment

Choose a reason for hiding this comment

Uh oh!

@code-asher code-asher Dec 2, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

@jsjoeio jsjoeio Dec 6, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Dec 1, 2021 •

edited

Loading

codecov bot commented Dec 1, 2021 •

edited

Loading

@code-asher code-asher Dec 2, 2021 •

edited

Loading