diff options
author | Josh Spicer <joshspicer@github.com> | 2022-06-21 23:14:14 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-06-21 23:14:14 +0300 |
commit | 3b6fe6e60843e5b9d77b6d97e9240910cd38c45b (patch) | |
tree | 805bca9bb38def19937698af88d1a5af6966eb34 | |
parent | ceab9628c66b240593fad1da6ba363684f7c1fff (diff) |
add descriptions to feature metadata (no-ci)
21 files changed, 64 insertions, 19 deletions
diff --git a/src/aws-cli/devcontainer-feature.json b/src/aws-cli/devcontainer-feature.json index ee1df10..2d353c6 100644 --- a/src/aws-cli/devcontainer-feature.json +++ b/src/aws-cli/devcontainer-feature.json @@ -1,6 +1,7 @@ { "id": "aws-cli", "name": "AWS CLI", + "description": "Installs the AWS CLI along with needed dependencies. Useful for base Dockerfiles that often are missing required install dependencies like gpg.", "options": { "version": { "type": "string", diff --git a/src/azure-cli/devcontainer-feature.json b/src/azure-cli/devcontainer-feature.json index 6ae3769..4a302c4 100644 --- a/src/azure-cli/devcontainer-feature.json +++ b/src/azure-cli/devcontainer-feature.json @@ -1,17 +1,22 @@ { "id": "azure-cli", "name": "Azure CLI", + "description": "Installs the Azure CLI along with needed dependencies. Useful for base Dockerfiles that often are missing required install dependencies like gpg.", "options": { "version": { "type": "string", - "proposals": ["latest"], + "proposals": [ + "latest" + ], "default": "latest", "description": "Select or enter an Azure CLI version. (Available versions may vary by Linux distribution.)" } }, - "extensions": ["ms-vscode.azurecli"], + "extensions": [ + "ms-vscode.azurecli" + ], "install": { "app": "", "file": "install.sh" } -} +}
\ No newline at end of file diff --git a/src/common/devcontainer-feature.json b/src/common/devcontainer-feature.json index 318d0cf..8cc6284 100644 --- a/src/common/devcontainer-feature.json +++ b/src/common/devcontainer-feature.json @@ -1,7 +1,7 @@ { "id": "common", - "name": "common", - "description": "common", + "name": "Common Debian", + "description": "Installs a set of common command line utilities, Oh My Zsh!, and sets up a non-root user.", "options": { "install_Zsh": { "type": "boolean", diff --git a/src/desktop-lite/devcontainer-feature.json b/src/desktop-lite/devcontainer-feature.json index fa7649c..365bcff 100644 --- a/src/desktop-lite/devcontainer-feature.json +++ b/src/desktop-lite/devcontainer-feature.json @@ -1,6 +1,7 @@ { "id": "desktop-lite", - "name": "Light-weight desktop (Fluxbox)", + "name": "Light-weight Desktop", + "description": "Adds a lightweight Fluxbox based desktop to the container that can be accessed using a VNC viewer or the web. GUI-based commands executed from the built-in VS code terminal will open on the desktop automatically.", "options": { "version": { "type": "string", diff --git a/src/docker-from-docker/devcontainer-feature.json b/src/docker-from-docker/devcontainer-feature.json index f9c5d28..c531d51 100644 --- a/src/docker-from-docker/devcontainer-feature.json +++ b/src/docker-from-docker/devcontainer-feature.json @@ -1,6 +1,7 @@ { "id": "docker-from-docker", - "name": "Docker (Moby) support, reuse host Docker Engine (Docker-from-Docker)", + "name": "Docker (Docker-from-Docker)", + "descripton": "Re-use the host docker socket, adding the Docker CLI to a container. Feature invokes a script to enable using a forwarded Docker socket within a container to run Docker commands.", "options": { "version": { "type": "string", diff --git a/src/docker-in-docker/devcontainer-feature.json b/src/docker-in-docker/devcontainer-feature.json index 096756d..12322ea 100644 --- a/src/docker-in-docker/devcontainer-feature.json +++ b/src/docker-in-docker/devcontainer-feature.json @@ -1,6 +1,7 @@ { "id": "docker-in-docker", - "name": "Docker (Moby) support (Docker-in-Docker)", + "name": "Docker (Docker-in-Docker)", + "description": "Create child containers *inside* a container, independent from the host's docker instance. Installs Docker extension in the container along with needed CLIs.", "options": { "version": { "type": "string", diff --git a/src/dotnet/devcontainer-feature.json b/src/dotnet/devcontainer-feature.json index 04b2811..723c151 100644 --- a/src/dotnet/devcontainer-feature.json +++ b/src/dotnet/devcontainer-feature.json @@ -1,6 +1,7 @@ { "id": "dotnet", "name": "Dotnet CLI", + "description": "Installs the .NET CLI. Provides option of installing sdk or runtime, and option of versions to install. Uses latest version of .NET sdk as defaults to install.", "options": { "version": { "type": "string", diff --git a/src/git-lfs/devcontainer-feature.json b/src/git-lfs/devcontainer-feature.json index 516454e..7404704 100644 --- a/src/git-lfs/devcontainer-feature.json +++ b/src/git-lfs/devcontainer-feature.json @@ -1,6 +1,7 @@ { "id": "git-lfs", "name": "Git Large File Support (LFS)", + "description": "Installs Git Large File Support (Git LFS) along with needed dependencies. Useful for base Dockerfiles that often are missing required install dependencies like git and curl.", "options": { "version": { "type": "string", diff --git a/src/git/devcontainer-feature.json b/src/git/devcontainer-feature.json index 6d9686b..ebe919f 100644 --- a/src/git/devcontainer-feature.json +++ b/src/git/devcontainer-feature.json @@ -1,10 +1,14 @@ { "id": "git", - "name": "Git (may require compilation)", + "name": "Git (from source)", + "description": "Install an up-to-date version of Git, built from source as needed. Useful for when you want the latest and greatest features. Auto-detects latest stable version and installs needed dependencies.", "options": { "version": { "type": "string", - "proposals": ["latest", "os-provided"], + "proposals": [ + "latest", + "os-provided" + ], "default": "os-provided", "description": "Select or enter a Git version." }, diff --git a/src/github-cli/devcontainer-feature.json b/src/github-cli/devcontainer-feature.json index a99634c..86869a6 100644 --- a/src/github-cli/devcontainer-feature.json +++ b/src/github-cli/devcontainer-feature.json @@ -1,6 +1,7 @@ { "id": "github-cli", "name": "GitHub CLI", + "description": "Installs the GitHub CLI. Auto-detects latest version and installs needed dependencies.", "options": { "version": { "type": "string", diff --git a/src/go/devcontainer-feature.json b/src/go/devcontainer-feature.json index 3c47c4a..927850e 100644 --- a/src/go/devcontainer-feature.json +++ b/src/go/devcontainer-feature.json @@ -1,24 +1,36 @@ { "id": "go", "name": "Go", + "description": "Installs Go and common Go utilities. Auto-detects latest version and installs needed dependencies.", "options": { "version": { "type": "string", - "proposals": ["latest", "none", "1.18", "1.17"], + "proposals": [ + "latest", + "none", + "1.18", + "1.17" + ], "default": "latest", "description": "Select or enter a Go version to install" } }, "init": true, - "extensions": ["golang.Go"], + "extensions": [ + "golang.Go" + ], "containerEnv": { "GOPATH": "/usr/local/go", "PATH": "${GOPATH}/bin:${PATH}" }, - "capAdd": [ "SYS_PTRACE" ], - "securityOpt": [ "seccomp=unconfined" ], + "capAdd": [ + "SYS_PTRACE" + ], + "securityOpt": [ + "seccomp=unconfined" + ], "install": { "app": "", "file": "install.sh" } -} +}
\ No newline at end of file diff --git a/src/java/devcontainer-feature.json b/src/java/devcontainer-feature.json index 64d5d65..20cae3d 100644 --- a/src/java/devcontainer-feature.json +++ b/src/java/devcontainer-feature.json @@ -1,6 +1,7 @@ { "id": "java", "name": "Java (via SDKMAN!)", + "description": "Installs Java, SDKMAN! (if not installed), and needed dependencies.", "options": { "version": { "type": "string", diff --git a/src/kubectl-helm-minikube/devcontainer-feature.json b/src/kubectl-helm-minikube/devcontainer-feature.json index 8b50879..9952cb2 100644 --- a/src/kubectl-helm-minikube/devcontainer-feature.json +++ b/src/kubectl-helm-minikube/devcontainer-feature.json @@ -1,6 +1,7 @@ { "id": "kubectl-helm-minikube", "name": "Kubectl, Helm, and Minkube", + "description": "Installs latest version of kubectl, Helm, and optionally minikube. Auto-detects latest versions and installs needed dependencies.", "options": { "version": { "type": "string", diff --git a/src/node/devcontainer-feature.json b/src/node/devcontainer-feature.json index 8d3bda6..ebce21b 100644 --- a/src/node/devcontainer-feature.json +++ b/src/node/devcontainer-feature.json @@ -1,6 +1,7 @@ { "id": "node", "name": "Node.js (via nvm) and yarn", + "description": "Installs Node.js, nvm, yarn, and needed dependencies.", "options": { "version": { "type": "string", diff --git a/src/oryx/devcontainer-feature.json b/src/oryx/devcontainer-feature.json index 5c3be58..2b569aa 100644 --- a/src/oryx/devcontainer-feature.json +++ b/src/oryx/devcontainer-feature.json @@ -1,6 +1,7 @@ { "id": "oryx", "name": "Oryx", + "description": "Installs the oryx CLI", "containerEnv": { "ORYX_SDK_STORAGE_BASE_URL": "https://oryx-cdn.microsoft.io", "ENABLE_DYNAMIC_INSTALL": "true", diff --git a/src/powershell/devcontainer-feature.json b/src/powershell/devcontainer-feature.json index 07e838f..7f2756f 100644 --- a/src/powershell/devcontainer-feature.json +++ b/src/powershell/devcontainer-feature.json @@ -1,6 +1,7 @@ { "id": "powershell", "name": "PowerShell", + "description": "Installs PowerShell along with needed dependencies. Useful for base Dockerfiles that often are missing required install dependencies like gpg.", "options": { "version": { "type": "string", diff --git a/src/python/devcontainer-feature.json b/src/python/devcontainer-feature.json index c32e18a..366a119 100644 --- a/src/python/devcontainer-feature.json +++ b/src/python/devcontainer-feature.json @@ -1,7 +1,7 @@ { "id": "python", - "name": "Python (may require compilation)", - "description": "Python (may require compilation)", + "name": "Python", + "description": "Installs the provided version of Python, as well as PIPX, and other common Python utilities. JupyterLab is conditionally installed with the python feature. Note: May require source code compilation.", "options": { "version": { "type": "string", diff --git a/src/ruby/devcontainer-feature.json b/src/ruby/devcontainer-feature.json index 919cf47..56ce1e1 100644 --- a/src/ruby/devcontainer-feature.json +++ b/src/ruby/devcontainer-feature.json @@ -1,10 +1,17 @@ { "id": "ruby", "name": "Ruby (via rvm)", + "description": "Installs Ruby, rvm, rbenv, common Ruby utilities, and needed dependencies.", "options": { "version": { "type": "string", - "proposals": ["latest", "none", "3.1", "3.0", "2.7"], + "proposals": [ + "latest", + "none", + "3.1", + "3.0", + "2.7" + ], "default": "latest", "description": "Select or enter a Ruby version to install" } diff --git a/src/rust/devcontainer-feature.json b/src/rust/devcontainer-feature.json index 147969f..bd3cd8b 100644 --- a/src/rust/devcontainer-feature.json +++ b/src/rust/devcontainer-feature.json @@ -1,6 +1,7 @@ { "id": "rust", "name": "Rust", + "description": "Installs Rust, common Rust utilities, and their required dependencies", "options": { "version": { "type": "string", diff --git a/src/sshd/devcontainer-feature.json b/src/sshd/devcontainer-feature.json index 4de71d9..b403834 100644 --- a/src/sshd/devcontainer-feature.json +++ b/src/sshd/devcontainer-feature.json @@ -1,10 +1,13 @@ { "id": "sshd", "name": "SSH server", + "description": "Adds a SSH server into a container so that you can use an external terminal, sftp, or SSHFS to interact with it.", "options": { "version": { "type": "string", - "enum": ["latest"], + "enum": [ + "latest" + ], "default": "latest", "description": "Currently unused." } diff --git a/src/terraform/devcontainer-feature.json b/src/terraform/devcontainer-feature.json index c999cae..4af6b00 100644 --- a/src/terraform/devcontainer-feature.json +++ b/src/terraform/devcontainer-feature.json @@ -1,6 +1,7 @@ { "id": "terraform", "name": "Terraform, tflint, and TFGrunt", + "description": "Installs the Terraform CLI and optionally TFLint and Terragrunt. Auto-detects latest version and installs needed dependencies.", "options": { "version": { "type": "string", |