Skip to content

Commit 23bf52a

Browse files
authored
Update VS Code Remote container doc (#553)
1 parent 416c7d1 commit 23bf52a

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

docs/internal/vs_code_remote_container.md

+13-7
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
# VS Code Remote Container
22

3-
> Git credentials need to be setup in order to commit changes inside the remote
4-
container using VS Code.
5-
63
VS Code Remote Containers is a quick way to get started with internal Mesop
74
development if you have [VS Code](https://code.visualstudio.com/) and
85
[Docker Desktop](https://www.docker.com/products/docker-desktop/) installed.
@@ -27,11 +24,20 @@ repository in a separate directory.
2724

2825
You can follow the instructions here on [how to fork and clone a Github repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo).
2926

30-
## Open folder in container
27+
## Share Git credentials with your container
3128

32-
> It is not recommended to develop locally and on remote containers using the same
33-
folder since this may cause conflicts with Bazel. Instead you should clone the
34-
repository in a separate directory.
29+
The VS Code Dev Containers extension provides a few ways to share your local Git
30+
credentials with your remote container.
31+
32+
If you cloned the Mesop repo using HTTPS, you can use a [Github CLI or Git Credential Manager](https://docs.github.com/en/get-started/getting-started-with-git/caching-your-github-credentials-in-git).
33+
34+
If you used SSH, then your local ssh agent will automatically be forwarded into your
35+
remote container. All you need do is run the `ssh-add` command to add the ssh key you've
36+
configured for GitHub access.
37+
38+
See the [Sharing Git credentials with your container page](https://code.visualstudio.com/remote/advancedcontainers/sharing-git-credentials) for full details.
39+
40+
## Open folder in container
3541

3642
Open VS Code, press `Cmd/Ctrl + Shift + P`, and select the `Dev Containers: Open Folder in Container...`
3743
option. This will create a new workspace inside a remote container.

0 commit comments

Comments
 (0)