microsoft / microsoft/vscode-remote-release

[devcontainers] Extension does not accept .devcontainer.json as a symlink

Open
#10,536 1 comment 0 reactions 1 assignee View on GitHub

@chrmarti is already working on this.

Since Dec 5, 2024.

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

Description

I have a few common configuration files stored in a submodule in my repo, among them is a devcontainer config file.
If i link to this file (ln -sr <sub-module>/devcontainer.json <repo-root>/.devcontainer.json) and open VS Code I don't get the "Folder contains a Dev Container configuration file"-popup. It does however work to create the symlink inside a .devcontainer-folder (ln -sr <sub-module>/devcontainer.json <repo-root>/.devcontainer/devcontainer.json).

To sum up:
✅ File named .devcontainer.json: Works
✅ File named .devcontainer/devcontainer.json: Works
✅ Symlink named .devcontainer/devcontainer.json: Works
❌ Symlink named .devcontainer.json: Doesn't work

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.