ee25034a77
This commit updates the recommended `Dockerfile` for VSCode remote development to take into account recent changes in our dev workflow (updated Node.js version, vendored yarn, modified CircleCI config). It also adds a note in the CircleCI config to keep the recommended `Dockerfile` up-to-date with the Node.js version used on CI. PR Close #41396 |
||
|---|---|---|
| .. | ||
| README.md | ||
| recommended-Dockerfile | ||
| recommended-devcontainer.json | ||
README.md
VSCode Remote Development - Developing inside a Container
This folder contains configuration files that can be used to opt into working on this repository in a Docker container via VSCode's Remote Development feature (see below).
Info on remote development and developing inside a container with VSCode:
Usage
Prerequisite: Install Docker on your local environment.
To get started, read and follow the instuctions in Developing inside a Container. The .devcontainer/ directory contains pre-configured devcontainer.json and Dockerfile files, which you can use to set up remote development with a docker container.
In a nutshell, you need to:
- Install the Remote - Containers extension.
- Copy recommended-Dockerfile to
Dockerfile(and optionally tweak to suit your needs). - Copy recommended-devcontainer.json to
devcontainer.json(and optionally tweak to suit your needs). - Open VSCode and bring up the Command Palette.
- Type
Remote-Containers: Open Folder in Containerand choose your local clone of angular/angular.
The .devcontainer/devcontainer.json and .devcontainer/Dockerfile files are ignored by git, so you can have your own local versions. We may occasionally update the template files (recommended-devcontainer.json, recommended-Dockerfile), in which case you will need to manually update your local copies (if desired).
Updating recommended-devcontainer.json and recommended-Dockerfile
You can update and commit the recommended config files (which people use as basis for their local configs), if you find that something is broken, out-of-date or can be improved.
Please, keep in mind that any changes you make will potentially be used by many people on different environments. Try to keep these config files cross-platform compatible and free of personal preferences.