microsoft / microsoft/vscode-remote-release

Extend the preconnect functionality

Open
#11,278 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

ssh
Dominant language
Dockerfile
Stars
4.2k
Forks
469
Avg merge
1d 1h
Merged PRs (30d)
1

Description

I'm currently trying to find a solution for an automatic sync to my target servers, when connection through VS Code remote SSH. I've already got my local shell scripts doing exactly that.

I've found the remote.SSH.preconnect option, which would potentially work, but I would need to create a script for each and every host I want to connect to, plus in my use case I am syncing different data depending on the user I'm connecting with. Which wouldn't be that big of a deal, if I would be working with a few VMs only. Currently I've got 70 host to user combinations, which can easily grow up to the hundreds.

So, instead of having hundreds of scripts it would be great to be able to add arguments to the config, at least in the per host configuration, and there at least some "hardcoded values". Even better if it would be possible to use the data which is already present in VS Code.

Minimum requirement:
"remote.SSH.preconnect": {
"host1": "/usr/local/bin/syncEnvironment user1 host",
"host2": "/usr/local/bin/syncEnvironment user2 host",
"host3": "/usr/local/bin/syncEnvironment user3 host",
},

Ideally:
"remote.SSH.preconnect": "/usr/local/bin/syncEnvironment $user-which-I-told-VSCode-to-connect-with $host-which-I-told-VScode-to-connect-to",

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the remote.SSH.preconnect setting and the existing local syncEnvironment scripts described in the issue. Determine how per-host configuration and the VS Code connection user and host values could be exposed; done means one configuration can invoke the sync command for many host/user combinations without a separate script for each host.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell, vscode
Domain
devtools
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.