VSCode sync with local installation

[yajo]

I'd love a way to sync settings from gitpod’s VSCode to my local VSCode installed in my laptop. That would provide an even more familiar workspace for me, with all the snippets, keybindings and extensions I’m used to.

Tasks

• merge [server] add vscode(-insiders) ouath2 clients #6272 and deploy new server
  • we need to run it for a while to make sure that it does not get reverted (like couple deployments)
  • we need to make it configurable that we can configure clients and scopes without deployment of meta in the future
• merge Implement gitpod auth and settings sync openvscode-server#337
  • add usage metrics for this feature
• release new Gitpod extension (only when sure that new server won't be reverted)
• add docs in https://www.gitpod.io/docs/develop/vscode-desktop-support#VS%20Code%20Desktop%20Support
• highlight in the CHANGELOG

[svenefftinge]

VS Code currently sets the user sync server provider in the product.json.
So we would need to alter that somehow. Our local app (yet to be built :-)) could possibly do that.

[akosyakov]

There is a hidden config, but i am not sure that GitHub tokens acuired by MS github authentication extension will work for authentication with us. It cannot work we actually allow access only with Gitpod token and "function:accessCodeSyncStorage" scope.

For the recode though, you will need to add following in your user settings and restart VS Code:

"configurationSync.store": {
        "url": "https://gitpod-staging.com/code-sync",
        "stableUrl": "https://gitpod-staging.com/code-sync",
        "insidersUrl": "https://gitpod-staging.com/code-sync",
        "canSwitch": true,
        "authenticationProviders": {
            "gitpod": {
                "scopes": ["function:accessCodeSyncStorage"]
            }
        }
    }

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[akosyakov]

We will implement Gitpod auth as a part of the Gitpod extension for VS Code Desktop, and distribute this extension as built-in for VSCode Web Server in order to resolve gitpod-io/openvscode-server#29 as well.

[akosyakov]

/schedule

[roboquat]

@akosyakov: Issue scheduled in the IDE team (WIP: 0)

In response to this:

/schedule

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[akosyakov]

I assigned myself for now, but @filiptronicek is working on it.

[akosyakov]

@mikenikles This one is tricky in the sense of CHANGELOG, the PR is done against another repo. So there is no automation.

I added another task to the description that we don't forget to highlight it.

[akosyakov]

Unfortunately we have to focus on JetBrains remote dev support in Q4 and don't have enough capacity to bring it in proper state. That's said many issue were already figure out, so we should be able to finish in next year. I will remove it from the groundwork for now.

[schickling]

As I keep my VSC settings.json in my dotfiles, it would be great if I could link to it in the dotfiles install script.

[rrapstine]

@yajo I'm a little late to the party, but would something like Settings Sync work for you in the interim? I used it before Microsoft acquired VSCode and it worked well. It syncs your settings, keybindings, extensions, and snippets to a Github Gist, which then just gets copied over to the appropriate place in your other instances.

[yajo]

Thanks @rrapstine. I currently use that extension locally because I recently switched to VSCodium. However, it seems forbidden in gitpod:

[filiptronicek]

However, it seems forbidden in gitpod:

@yajo it seems that the extension authors disabled the extension from running in remote contexts - from the docs:

"extensionKind": ["ui"] — Indicates the extension must run close to the UI because it requires access to local assets, devices, or capabilities or because low latency is required. In the case of VS Code for the Web with Codespaces, where no local extension host is available, such an extension can not load, unless it is also a web extension. It will then be loaded in the web extension host.

It looks like there is an issue for this but hasn't been touched since 2020: shanalikhan/code-settings-sync#1209.

[loujaybee]

Removed epic label from this issue in favour of: #9136 (added to roadmap)

[loujaybee]

Seems we forgot to close this one!

This shipped a couple of weeks ago, see the changelog update and the docs! 🚀 🙏

https://www.gitpod.io/changelog/vs-code-desktop-settings-sync
https://www.gitpod.io/docs/ides-and-editors/settings-sync

If you have any feedback, let us know 🚀

[schickling]

I keep my VSC settings files manually in my dotfiles repo. Is there a way to use my VSC settings files in Gitpod instead of the automatic settings sync?

[jeanp413]

Not possible as settings in vscode browser are stored in the browser localstorage so only way to sync them is using settings sync

[schickling]

Not possible as settings in vscode browser are stored in the browser localstorage so only way to sync them is using settings sync

Wouldn't it be possible for Gitpod to support some kind of "import settings from JSON" workflow? (e.g. via the gp CLI?)

Can I use both VSC sync (via Microsoft) and VSC sync (via Gitpod) at the same time?

[jeanp413]

Wouldn't it be possible for Gitpod to support some kind of "import settings from JSON" workflow? (e.g. via the gp CLI?)

Maybe a command in the gitpod extension that reads a file and uses the vscode API to update settings could work, but what about merge conflicts, etc. I suggest you to create a separate issue as a feature request.

Can I use both VSC sync (via Microsoft) and VSC sync (via Gitpod) at the same time?

Nope, why would you want to use both? Are you using codespaces or vscode.dev too? (we plan to investigate if our settings sync also works there)

[schickling]

Nope, why would you want to use both? Are you using codespaces or vscode.dev too? (we plan to investigate if our settings sync also works there)

Yes, I'm using github.dev a lot as well. I don't want to have to choose for one or the other.

I suggest you to create a separate issue as a feature request.

Done: #10702