microsoft / microsoft/vscode-remote-release

Import common baseline definitions (Containers)

Open
#3,568 3 comments 4 reactions 1 assignee View on GitHub

@chrmarti is already working on this.

Since Aug 31, 2020.

containers feature-request plan-review
Dominant language
Dockerfile
Stars
4.2k
Forks
470
Avg merge
1d 1h
Merged PRs (30d)
1

Description

I would like to request that VS Code Remote - Containers support importing common baseline dev container definitions from source control. My team heavily uses dev containers in a large organization, and we have over time developed standard, best practice common configurations that apply to all or almost all our projects. However, because we have to duplicate those common parts of the definitions in every repository, updating that common baseline across all our repos is effectively impossible.

Instead, I would like VS Code Remote - Containers definitions to be able to "import" or "inherit" one or more external definitions stored in Git repositories. The extension would merge the definitions together at dev container build time, and the properties in the devcontainer.json would override the same properties in the imported definitions. An example might look something like this:

{
    "image": "webdev:latest",
    // Merge all properties from these definitions in Git.
    "import": [ { "cloneUrl": "https://github.com/jdoe/dev-containers.git", "path": "common/best-practices.json" } ],
    // If best-practices.json above has the settings.editor.rulers property, override it with the following.
    "settings": { "editor.rulers": [ 80, 120 ] }
}

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.