devcontainers-contrib/templates

📂 Pre-made .devcontainer folders for starting your next project

templates's Issues

Fix devcontainer configuration

Currently it errors in GitHub Codespaces:

2023-01-02 02:15:12.324Z: #10 extracting sha256:d89fc30901ae69eb383fe706db336fc64c2869df9b05503acf27d664b4747110 47.1s
2023-01-02 02:15:17.383Z: #10 extracting sha256:d89fc30901ae69eb383fe706db336fc64c2869df9b05503acf27d664b4747110 52.1s
2023-01-02 02:15:23.100Z: #10 extracting sha256:d89fc30901ae69eb383fe706db336fc64c2869df9b05503acf27d664b4747110 57.8s
2023-01-02 02:15:28.112Z: #10 extracting sha256:d89fc30901ae69eb383fe706db336fc64c2869df9b05503acf27d664b4747110 62.9s
2023-01-02 02:15:30.520Z: #10 ERROR: failed to register layer: ApplyLayer exit status 1 stdout:  stderr: write /home/codespace/.local/lib/python3.10/site-packages/torch/lib/libtorch_cuda_cu.so: no space left on device
2023-01-02 02:15:30.604Z: ------
2023-01-02 02:15:30.604Z:  > [dev_containers_feature_content_normalize 1/3] FROM mcr.microsoft.com/devcontainers/universal:2.1.3-focal@sha256:a0ee9ebef10ed5b1889d58a039b478cce153beb6ec955681232ef47cbd394eb4:
2023-01-02 02:15:30.604Z: 
2023-01-02 02:15:30.605Z: ------
2023-01-02 02:15:30.605Z: 
2023-01-02 02:15:30.632Z: ERROR: failed to solve: failed to register layer: ApplyLayer exit status 1 stdout:  stderr: write /home/codespace/.local/lib/python3.10/site-packages/torch/lib/libtorch_cuda_cu.so: no space left on device
2023-01-02 02:15:30.688Z: Stop (228644 ms): Run: docker buildx build --load --build-context dev_containers_feature_content_source=/tmp/devcontainercli-root/container-features/0.26.0-1672625499649 --build-arg _DEV_CONTAINERS_BASE_IMAGE=mcr.microsoft.com/devcontainers/universal:2.1.3-focal --build-arg _DEV_CONTAINERS_IMAGE_USER=root --build-arg _DEV_CONTAINERS_FEATURE_CONTENT_SOURCE=dev_container_feature_content_temp --target dev_containers_target_stage -t vsc-templates-cfae15ea720226f927c3667aae3187fa-features -f /tmp/devcontainercli-root/container-features/0.26.0-1672625499649/Dockerfile.extended /var/lib/docker/codespacemount/.persistedshare/empty-folder
2023-01-02 02:15:30.689Z: Error: Command failed: docker buildx build --load --build-context dev_containers_feature_content_source=/tmp/devcontainercli-root/container-features/0.26.0-1672625499649 --build-arg _DEV_CONTAINERS_BASE_IMAGE=mcr.microsoft.com/devcontainers/universal:2.1.3-focal --build-arg _DEV_CONTAINERS_IMAGE_USER=root --build-arg _DEV_CONTAINERS_FEATURE_CONTENT_SOURCE=dev_container_feature_content_temp --target dev_containers_target_stage -t vsc-templates-cfae15ea720226f927c3667aae3187fa-features -f /tmp/devcontainercli-root/container-features/0.26.0-1672625499649/Dockerfile.extended /var/lib/docker/codespacemount/.persistedshare/empty-folder
2023-01-02 02:15:30.701Z:     at Kne (/usr/lib/node_modules/@microsoft/vscode-dev-containers-cli/dist/spec-node/devContainersSpecCLI.js:1865:1355)
2023-01-02 02:15:30.716Z:     at x7 (/usr/lib/node_modules/@microsoft/vscode-dev-containers-cli/dist/spec-node/devContainersSpecCLI.js:1865:1291)
2023-01-02 02:15:30.716Z:     at processTicksAndRejections (internal/process/task_queues.js:95:5)
2023-01-02 02:15:30.717Z:     at async oie (/usr/lib/node_modules/@microsoft/vscode-dev-containers-cli/dist/spec-node/devContainersSpecCLI.js:1871:2093)
2023-01-02 02:15:30.717Z:     at async qf (/usr/lib/node_modules/@microsoft/vscode-dev-containers-cli/dist/spec-node/devContainersSpecCLI.js:1871:3239)
2023-01-02 02:15:30.717Z:     at async Mse (/usr/lib/node_modules/@microsoft/vscode-dev-containers-cli/dist/spec-node/devContainersSpecCLI.js:1995:16211)
2023-01-02 02:15:30.718Z:     at async Lse (/usr/lib/node_modules/@microsoft/vscode-dev-containers-cli/dist/spec-node/devContainersSpecCLI.js:1995:15965)
2023-01-02 02:15:30.718Z: Stop (231745 ms): Run: /usr/bin/node /usr/lib/node_modules/@microsoft/vscode-dev-containers-cli/dist/spec-node/devContainersSpecCLI.js up --user-data-folder /var/lib/docker/codespacemount/.persistedshare --container-data-folder .vscode-remote/data/Machine --container-system-data-folder /var/vscode-remote --workspace-folder /var/lib/docker/codespacemount/workspace/templates --id-label Type=codespaces --log-level info --log-format json --config /var/lib/docker/codespacemount/workspace/templates/.devcontainer/devcontainer.json --override-config /root/.codespaces/shared/merged_devcontainer.json --default-user-env-probe loginInteractiveShell --mount type=bind,source=/.codespaces/agent/mount/cache,target=/vscode --skip-post-create --update-remote-user-uid-default never --mount-workspace-git-root false
2023-01-02 02:15:30.718Z: Exit code 1

====================================== ERROR ====================================
2023-01-02 02:15:30.720Z: Failed to create container.
=================================================================================
2023-01-02 02:15:30.727Z: Error: Command failed: /usr/bin/node /usr/lib/node_modules/@microsoft/vscode-dev-containers-cli/dist/spec-node/devContainersSpecCLI.js up --user-data-folder /var/lib/docker/codespacemount/.persistedshare --container-data-folder .vscode-remote/data/Machine --container-system-data-folder /var/vscode-remote --workspace-folder /var/lib/docker/codespacemount/workspace/templates --id-label Type=codespaces --log-level info --log-format json --config /var/lib/docker/codespacemount/workspace/templates/.devcontainer/devcontainer.json --override-config /root/.codespaces/shared/merged_devcontainer.json --default-user-env-probe loginInteractiveShell --mount type=bind,source=/.codespaces/agent/mount/cache,target=/vscode --skip-post-create --update-remote-user-uid-default never --mount-workspace-git-root false
2023-01-02 02:15:30.732Z: Error Code: 1302

====================================== ERROR ====================================
2023-01-02 02:15:30.754Z: Container creation failed.
=================================================================================

Specifically:

ERROR: failed to register layer: ApplyLayer exit status 1 stdout:  stderr: write /home/codespace/.local/lib/python3.10/site-packages/torch/lib/libtorch_cuda_cu.so: no space left on device
ERROR: failed to solve: failed to register layer: ApplyLayer exit status 1 stdout:  stderr: write /home/codespace/.local/lib/python3.10/site-packages/torch/lib/libtorch_cuda_cu.so: no space left on device

Supposedly GitHub Codespaces gives you 2 cores and 32GB of storage. To use that all up is quite not good for a feature (or whatever caused this)!

@jcbhmr ➜ /workspaces/templates (main) $ df -h
Filesystem      Size  Used Avail Use% Mounted on
overlay          32G  954M   29G   4% /
tmpfs            64M     0   64M   0% /dev
tmpfs           2.0G     0  2.0G   0% /sys/fs/cgroup
shm              64M     0   64M   0% /dev/shm
/dev/sdb1        16G  140K   15G   1% /tmp
/dev/sda1        29G   12G   18G  40% /vscode
/dev/loop0       32G  954M   29G   4% /workspaces
tmpfs           2.0G     0  2.0G   0% /proc/acpi
tmpfs           2.0G     0  2.0G   0% /proc/scsi
tmpfs           2.0G     0  2.0G   0% /sys/firmware

Problem with devcontainer.json

devcontainer.json does not build in JetBrains IDE 2024.1 and VSCode.

JetBrains IDE Welcome screen -> DevContainers -> New DevContainer (from VCS Project, Docker must be installed.) Insert the git@ link of the repository with devcontainer.json. -> "Build container and Continue"

Add proper description & tags

I don't think this repo has a description as of yet. It would probably be a good idea to add one.

It should probably be the same as the tagline thing in the readme (at least, that's my @jcbhmr convention). That description is currently:

📂 Pre-made .devcontainer folders for starting your next project

☝ I think this one is the weakest of the bunch shown below. I might change the readme around and add a better header image with a new tagline.

Here are some other ideas:

• 💻 80% of the configuration you'll ever need
• 🥧 Ready-made devcontainer.json files for popular projects
• 🚀 Devcontainer configurations to get you off the ground
• 📋 Template devcontainer.json files for popular projects
• 🚀 @devcontainers configurations to get you started

I think that an emoji is a good idea, but that's again the @jcbhmr convention peeking through. Some other popular orgs/people do it too, though: https://github.com/wow-actions https://github.com/sindresorhus

I don't have the power to actually edit the description/URL/tags of this repo. That falls on you @danielbraun89 🤷‍♂️

Speaking of tags, while you're at it, here's some ideas for tags:

• https://github.com/topics/devcontainer
• https://github.com/topics/devcontainer-template
• https://github.com/topics/getting-started

Enable GitHub Pages deployment from GitHub Actions

This would let the site deploy successfully. (Hopefully. Assuming all other CI config works.)

This SO answer https://stackoverflow.com/questions/73937666/configure-github-pages-failed indicates that this error means GitHub Pages deployments are not set to GitHub Actions.

@danielbraun89

[discussion:idea] Create GitHub Pages site for options & template READMEs instead of src/*/README.md

This should be moved to the Discussions tab if Discussions get enabled
This is related to the changes that are suggested in devcontainers-contrib/.github#3

Discussion questions

• Would this be a good idea?
• Do we want a website just for our templates, or a generic website that indexes all the templates from [the official community index]? (separate repo)
• Would this be a good idea to pursue in other features/images repos?
• Is there an alternative to this idea that's better?

What this idea is trying to solve

The goal is to remove the GitHub Actions auto-generating the README.md from the devcontainer-template.json. If we can move this "commit the README.md to GitHub for docs purposes" to something like "publish to the GitHub Wiki for docs purposes" or "publish to GitHub Pages for docs purposes", that'd be great!

The problem that this goal is trying to solve is:

• PR spam on the repo
• General clutter of stuff that doesn't need to be in source Git
• Changes that don't need to be in source control
• In the future, potential merge conflicts (?)

Here's an example: #2

Looking for feedback on this idea from @danielbraun89 and any others.

Add templates for...

The current official devcontainers/templates repo has the following templates:

• alpine
• anaconda-postgres
• anaconda
• cpp-mariadb
• cpp
• debian
• docker-existing-docker-compose
• docker-existing-dockerfile
• docker-in-docker
• docker-outside-of-docker-compose
• docker-outside-of-docker
• dotnet-fsharp
• dotnet-mssql
• dotnet-postgres
• dotnet
• go-postgres
• go
• java-postgres
• java
• javascript-node-mongo
• javascript-node-postgres
• javascript-node
• jekyll
• kubernetes-helm-minikube
• kubernetes-helm
• markdown
• miniconda-postgres
• miniconda
• php-mariadb
• php
• postgres
• powershell
• python
• ruby-rails-postgres
• ruby
• rust-postgres
• rust
• typescript-node
• ubuntu
• universal

Here's some other templates that I think would be good to have:

• deno: Includes Deno runtime (could have accompanying image)
• haskell: Includes the Haskell toolchain (could have accompanying image)
• eleventy: Devcontainer with preset npm i -g @11ty/eleventy

Some other ideas for things (non-specific) that could also be added:

• Other static site generators
• Any other images if we ever create a devcontainers-contrib/images repo

Looking for other template ideas to add to this list!

Enable discussions on this repo

Since this repo now has a discussion issue, I think it's a good time to enable actual discussions to properly segment the issues and discussions. While I agree discussions shouldn't be enabled until they're needed, that time when they are needed is upon us.

I don't have the power to do this directly. Only @danielbraun89 can do this.

Migrate from `microsoft/vscode-dev-containers`?

It has been several months since the deprecation of https://github.com/microsoft/vscode-dev-containers, the predecessor to Dev Container Templates, was announced (microsoft/vscode-dev-containers#1589), and the only ones that have actually moved from microsoft/vscode-dev-containers to their own templates are the devcontainers ones (i.e., those managed by Microsoft) and the R templates that I managed (microsoft/vscode-dev-containers#1673).

For the R template, there was no problem migrating to rocker-org, which manages the R Docker images, because I am a member of rocker-org.
However, for other community templates, it is possible that no suitable migration site can be found.

Wondering if it would be possible to contact each maintainer of the community templates in microsoft/vscode-dev-containers and move it here if they agree.