Add a devcontainer configuration #7583
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
VS Code [devcontainers][dc] provide a way to define a reproducible, customizable developer environment. This should lower the barrier to entry for contributors and reduce the maintenance burden for existing developers, as a docker daemon is now basically all that's needed to get up and running. This change adds a devcontainer for the Linkerd2 project. Its container starts in the host's network so that it can easily access k3d clusters running on the host's docker daemon. [dc]: https://code.visualstudio.com/docs/remote/containers Signed-off-by: Oliver Gould <ver@buoyant.io>
Signed-off-by: Oliver Gould <ver@buoyant.io>
Signed-off-by: Oliver Gould <ver@buoyant.io>
adleong
approved these changes
Jan 11, 2022
There was a problem hiding this comment.
This is sweet.
Worth noting that simply opening the workspace in a devcontainer didn't work for me because my docker daemon runs on a remote host and my local filesystem paths and remote filesystem paths don't line up. However, doing "clone a PR in a devcontainer" worked like a charm and I imagine that "close a repo in a devcontainer" will work as well once this is merged.
One small thing I noticed is that the markdownlint script requires npm, so we may want to add that to the container as well:
$ bin/markdownlint
Error: npm required to install markdownlint command
|
a little cray that npm pulls in ~300MB just to run that script, but that's for another day. i'll try to get markdownlint-cli preinstalled in the image. |
olix0r
commented
Jan 11, 2022
Comment on lines
+10
to
+12
| export PATH="$rootdir/node_modules/.bin:$PATH" | ||
|
|
||
| if ! command -v markdownlint >/dev/null || [ "$(markdownlint -V)" != "$version" ]; then |
There was a problem hiding this comment.
I've updated this script to be able to use a globally installed markdownlint
You'll probably have better luck using VSCode's |
Signed-off-by: Oliver Gould <ver@buoyant.io>
olix0r
added a commit
that referenced
this pull request
Mar 31, 2022
VS Code [devcontainers][dc] provide a way to define a reproducible, customizable developer environment. This should lower the barrier to entry for contributors and reduce the maintenance burden for existing developers, as a docker daemon is now basically all that's needed to get up and running. This change adds a devcontainer for the Linkerd2 project. Its container starts in the host's network so that it can easily access k3d clusters running on the host's docker daemon. [dc]: https://code.visualstudio.com/docs/remote/containers Signed-off-by: Oliver Gould <ver@buoyant.io> (cherry picked from commit f33bb7b) Signed-off-by: Oliver Gould <ver@buoyant.io>
olix0r
added a commit
that referenced
this pull request
Mar 31, 2022
VS Code [devcontainers][dc] provide a way to define a reproducible, customizable developer environment. This should lower the barrier to entry for contributors and reduce the maintenance burden for existing developers, as a docker daemon is now basically all that's needed to get up and running. This change adds a devcontainer for the Linkerd2 project. Its container starts in the host's network so that it can easily access k3d clusters running on the host's docker daemon. [dc]: https://code.visualstudio.com/docs/remote/containers Signed-off-by: Oliver Gould <ver@buoyant.io> (cherry picked from commit f33bb7b) Signed-off-by: Oliver Gould <ver@buoyant.io>
olix0r
added a commit
that referenced
this pull request
Apr 2, 2022
VS Code [devcontainers][dc] provide a way to define a reproducible, customizable developer environment. This should lower the barrier to entry for contributors and reduce the maintenance burden for existing developers, as a docker daemon is now basically all that's needed to get up and running. This change adds a devcontainer for the Linkerd2 project. Its container starts in the host's network so that it can easily access k3d clusters running on the host's docker daemon. [dc]: https://code.visualstudio.com/docs/remote/containers Signed-off-by: Oliver Gould <ver@buoyant.io> (cherry picked from commit f33bb7b) Signed-off-by: Oliver Gould <ver@buoyant.io>
olix0r
added a commit
that referenced
this pull request
Apr 7, 2022
VS Code [devcontainers][dc] provide a way to define a reproducible, customizable developer environment. This should lower the barrier to entry for contributors and reduce the maintenance burden for existing developers, as a docker daemon is now basically all that's needed to get up and running. This change adds a devcontainer for the Linkerd2 project. Its container starts in the host's network so that it can easily access k3d clusters running on the host's docker daemon. [dc]: https://code.visualstudio.com/docs/remote/containers Signed-off-by: Oliver Gould <ver@buoyant.io> (cherry picked from commit f33bb7b) Signed-off-by: Oliver Gould <ver@buoyant.io>
olix0r
added a commit
that referenced
this pull request
Apr 8, 2022
VS Code [devcontainers][dc] provide a way to define a reproducible, customizable developer environment. This should lower the barrier to entry for contributors and reduce the maintenance burden for existing developers, as a docker daemon is now basically all that's needed to get up and running. This change adds a devcontainer for the Linkerd2 project. Its container starts in the host's network so that it can easily access k3d clusters running on the host's docker daemon. [dc]: https://code.visualstudio.com/docs/remote/containers Signed-off-by: Oliver Gould <ver@buoyant.io> (cherry picked from commit f33bb7b) Signed-off-by: Oliver Gould <ver@buoyant.io>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
VS Code devcontainers provide a way to define a reproducible,
customizable developer environment. This should lower the barrier to
entry for contributors and reduce the maintenance burden for existing
developers, as a docker daemon is now basically all that's needed to get
up and running.
This change adds a devcontainer for the Linkerd2 project. Its container
starts in the host's network so that it can easily access k3d clusters
running on the host's docker daemon.
This change also bumps the rust toolchain version to v1.56.1, as some
tools cannot be installed with v1.56.0.
Signed-off-by: Oliver Gould ver@buoyant.io