doc: update devcontainer.json and add documentation #60472
Conversation
|
Review requested:
|
nodejs-github-bot
added
the
meta
joyeecheung
force-pushed
the
devcontainer
branch
from
3b4e7c2 to
3f2d020
Compare
The previous .devcontainer.json configuration was outdated and contained personal configurations that were not needed to run a dev container. This updates the structure so that it's put in .devcontainer/base/devcontainer.json based on the recommended setup in GitHub's documentation. The official image now publishes both arm64 and amd64 images, and devcontainer tools should be able to pick up the right one without extra arguments. This also adds documentation on how to use the container. Refs: https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#devcontainerjson
joyeecheung
force-pushed
the
devcontainer
branch
from
3f2d020 to
0406320
Compare
|
cc @nodejs/devcontainer |
Co-authored-by: Tierney Cyren <accounts@bnb.im>
|
Updated the documentation to address reviews. Can you take another look? Thanks @aduh95 @bnb By the way I just realized with this, new contributors do not even have to download anything locally to start working on Node.js, they can just use GitHub codespace to spin off the developement environment in the browser. This may be very handy for future code and learn sessions - just click a few buttons and you can start working on Node.js core. I've put a link to the doc (maybe we should make it the main tutorial, but I haven't used this enough yet to write a detailed guide, also this may be a paid feature of GitHub and I don't know much about what free tier is available): 
|
joyeecheung
force-pushed
the
devcontainer
branch
from
f59253b to
9ceafde
Compare
|
Can you take another look please? @bnb |
4 participants
The previous .devcontainer.json configuration was outdated and contained personal configurations that were not needed to run a dev container. This updates the structure so that it's put in .devcontainer/base/devcontainer.json based on the recommended setup in GitHub's documentation. The official image now publishes both arm64 and amd64 images, and devcontainer tools should be able to pick up the right one without extra arguments.
This also adds documentation on how to use the container.
I've also recorded a screencast on how to use the dev container to build a development branch in the Linux container from a macOS host without having to build V8 from scratch, and to test third party code installed from npm using the development branch build in the container: https://www.youtube.com/watch?v=3NwaA67jnB0
Refs: https://github.com/nodejs/devcontainer
Refs: https://hub.docker.com/r/nodejs/devcontainer
Refs: https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#devcontainerjson