Skip to content

Automated documentation update #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
github-actions wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Automated documentation update #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a3ff7a5
Update update-documentation.yml
cmbrose Oct 31, 2022
23f031c
Update update-documentation.yml
cmbrose Oct 31, 2022
26e5a1f
Automated documentation update [skip ci]
invalid-email-address Oct 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/update-documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
- uses: actions/checkout@v2

- name: Generate Documentation
uses: devcontainers/action@v1
uses: cmbrose/action@v0.1-cmbrose
with:
generate-docs: "true"
base-path-to-features: "./src"
Expand Down
4 changes: 2 additions & 2 deletions src/anaconda/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

```json
"features": {
"ghcr.io/devcontainers/features/anaconda:1": {
"ghcr.io/cmbrose/devcontainer-features/anaconda:1": {
"version": "latest"
}
}
Expand Down Expand Up @@ -36,4 +36,4 @@ conda install python=3.7

---

_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/anaconda/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/cmbrose/devcontainer-features/blob/main/src/anaconda/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
4 changes: 2 additions & 2 deletions src/aws-cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Installs the AWS CLI along with needed dependencies. Useful for base Dockerfiles

```json
"features": {
"ghcr.io/devcontainers/features/aws-cli:1": {
"ghcr.io/cmbrose/devcontainer-features/aws-cli:1": {
"version": "latest"
}
}
Expand All @@ -23,4 +23,4 @@ Available versions of the AWS CLI can be found here: https://github.com/aws/aws-

---

_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/aws-cli/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/cmbrose/devcontainer-features/blob/main/src/aws-cli/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
4 changes: 2 additions & 2 deletions src/azure-cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Installs the Azure CLI along with needed dependencies. Useful for base Dockerfil

```json
"features": {
"ghcr.io/devcontainers/features/azure-cli:1": {
"ghcr.io/cmbrose/devcontainer-features/azure-cli:1": {
"version": "latest"
}
}
Expand All @@ -23,4 +23,4 @@ Installs the Azure CLI along with needed dependencies. Useful for base Dockerfil

---

_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/azure-cli/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/cmbrose/devcontainer-features/blob/main/src/azure-cli/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
6 changes: 3 additions & 3 deletions src/common-utils/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Installs a set of common command line utilities, Oh My Zsh!, and sets up a non-r

```json
"features": {
"ghcr.io/devcontainers/features/common-utils:1": {
"ghcr.io/cmbrose/devcontainer-features/common-utils:1": {
"version": "latest"
}
}
Expand All @@ -23,7 +23,7 @@ Installs a set of common command line utilities, Oh My Zsh!, and sets up a non-r
| username | Enter name of non-root user to configure or none to skip | string | automatic |
| uid | Enter uid for non-root user | string | automatic |
| gid | Enter gid for non-root user | string | automatic |
| nonFreePackages | Add packages from non-free Debian repository? | boolean | - |
| nonFreePackages | Add packages from non-free Debian repository? | boolean | false |

## Speeding up the command prompt in large repositories

Expand All @@ -41,4 +41,4 @@ This setting will survive a rebuild since it is applied to the repository rather

---

_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/common-utils/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/cmbrose/devcontainer-features/blob/main/src/common-utils/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
6 changes: 3 additions & 3 deletions src/conda/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ A cross-platform, language-agnostic binary package manager

```json
"features": {
"ghcr.io/devcontainers/features/conda:1": {
"ghcr.io/cmbrose/devcontainer-features/conda:1": {
"version": "latest"
}
}
Expand All @@ -18,7 +18,7 @@ A cross-platform, language-agnostic binary package manager
| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| version | Select or enter a conda version. | string | latest |
| addCondaForge | Add conda-forge channel to the config? | boolean | - |
| addCondaForge | Add conda-forge channel to the config? | boolean | false |

## Using Conda

Expand All @@ -37,4 +37,4 @@ conda install python=3.7

---

_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/conda/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/cmbrose/devcontainer-features/blob/main/src/conda/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
4 changes: 2 additions & 2 deletions src/desktop-lite/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Adds a lightweight Fluxbox based desktop to the container that can be accessed u

```json
"features": {
"ghcr.io/devcontainers/features/desktop-lite:1": {
"ghcr.io/cmbrose/devcontainer-features/desktop-lite:1": {
"version": "latest"
}
}
Expand Down Expand Up @@ -91,4 +91,4 @@ That's it!

---

_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/desktop-lite/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/cmbrose/devcontainer-features/blob/main/src/desktop-lite/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
4 changes: 2 additions & 2 deletions src/docker-from-docker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

```json
"features": {
"ghcr.io/devcontainers/features/docker-from-docker:1": {
"ghcr.io/cmbrose/devcontainer-features/docker-from-docker:1": {
"version": "latest"
}
}
Expand Down Expand Up @@ -51,4 +51,4 @@ docker run -it --rm -v ${LOCAL_WORKSPACE_FOLDER}:/workspace debian bash

---

_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/docker-from-docker/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/cmbrose/devcontainer-features/blob/main/src/docker-from-docker/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
6 changes: 3 additions & 3 deletions src/docker-in-docker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Create child containers *inside* a container, independent from the host's docker

```json
"features": {
"ghcr.io/devcontainers/features/docker-in-docker:1": {
"ghcr.io/cmbrose/devcontainer-features/docker-in-docker:1": {
"version": "latest"
}
}
Expand All @@ -21,10 +21,10 @@ Create child containers *inside* a container, independent from the host's docker
| moby | Install OSS Moby build instead of Docker CE | boolean | true |
| dockerDashComposeVersion | Default version of Docker Compose (v1 or v2) | string | v1 |
| azureDnsAutoDetection | Allow automatically setting the dockerd DNS server when the installation script detects it is running in Azure | boolean | true |
| dockerDefaultAddressPool | Define default address pools for Docker networks. e.g. base=192.168.0.0/16,size=24 | string | - |
| dockerDefaultAddressPool | Define default address pools for Docker networks. e.g. base=192.168.0.0/16,size=24 | string | |



---

_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/docker-in-docker/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/cmbrose/devcontainer-features/blob/main/src/docker-in-docker/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
6 changes: 3 additions & 3 deletions src/dotnet/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Installs the .NET CLI. Provides option of installing sdk or runtime, and option

```json
"features": {
"ghcr.io/devcontainers/features/dotnet:1": {
"ghcr.io/cmbrose/devcontainer-features/dotnet:1": {
"version": "latest"
}
}
Expand All @@ -18,11 +18,11 @@ Installs the .NET CLI. Provides option of installing sdk or runtime, and option
| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| version | Select or enter a dotnet CLI version. (Available versions may vary by Linux distribution.) | string | latest |
| runtimeOnly | Install just the dotnet runtime if true, and sdk if false. | boolean | - |
| runtimeOnly | Install just the dotnet runtime if true, and sdk if false. | boolean | false |
| installUsingApt | If true, it installs using apt instead of the release URL | boolean | true |



---

_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/dotnet/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/cmbrose/devcontainer-features/blob/main/src/dotnet/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
4 changes: 2 additions & 2 deletions src/git-lfs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Installs Git Large File Support (Git LFS) along with needed dependencies. Useful

```json
"features": {
"ghcr.io/devcontainers/features/git-lfs:1": {
"ghcr.io/cmbrose/devcontainer-features/git-lfs:1": {
"version": "latest"
}
}
Expand All @@ -23,4 +23,4 @@ Installs Git Large File Support (Git LFS) along with needed dependencies. Useful

---

_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/git-lfs/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/cmbrose/devcontainer-features/blob/main/src/git-lfs/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
4 changes: 2 additions & 2 deletions src/git/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Install an up-to-date version of Git, built from source as needed. Useful for wh

```json
"features": {
"ghcr.io/devcontainers/features/git:1": {
"ghcr.io/cmbrose/devcontainer-features/git:1": {
"version": "latest"
}
}
Expand All @@ -24,4 +24,4 @@ Install an up-to-date version of Git, built from source as needed. Useful for wh

---

_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/git/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/cmbrose/devcontainer-features/blob/main/src/git/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
4 changes: 2 additions & 2 deletions src/github-cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Installs the GitHub CLI. Auto-detects latest version and installs needed depende

```json
"features": {
"ghcr.io/devcontainers/features/github-cli:1": {
"ghcr.io/cmbrose/devcontainer-features/github-cli:1": {
"version": "latest"
}
}
Expand All @@ -24,4 +24,4 @@ Installs the GitHub CLI. Auto-detects latest version and installs needed depende

---

_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/github-cli/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/cmbrose/devcontainer-features/blob/main/src/github-cli/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
4 changes: 2 additions & 2 deletions src/go/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Installs Go and common Go utilities. Auto-detects latest version and installs ne

```json
"features": {
"ghcr.io/devcontainers/features/go:1": {
"ghcr.io/cmbrose/devcontainer-features/go:1": {
"version": "latest"
}
}
Expand All @@ -24,4 +24,4 @@ Installs Go and common Go utilities. Auto-detects latest version and installs ne

---

_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/go/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/cmbrose/devcontainer-features/blob/main/src/go/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
4 changes: 2 additions & 2 deletions src/hugo/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

```json
"features": {
"ghcr.io/devcontainers/features/hugo:1": {
"ghcr.io/cmbrose/devcontainer-features/hugo:1": {
"version": "latest"
}
}
Expand All @@ -23,4 +23,4 @@

---

_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/hugo/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/cmbrose/devcontainer-features/blob/main/src/hugo/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
8 changes: 4 additions & 4 deletions src/java/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Installs Java, SDKMAN! (if not installed), and needed dependencies.

```json
"features": {
"ghcr.io/devcontainers/features/java:1": {
"ghcr.io/cmbrose/devcontainer-features/java:1": {
"version": "latest"
}
}
Expand All @@ -19,8 +19,8 @@ Installs Java, SDKMAN! (if not installed), and needed dependencies.
|-----|-----|-----|-----|
| version | Select or enter a Java version to install | string | latest |
| jdkDistro | Select or enter a JDK distribution | string | ms |
| installGradle | Install Gradle, a build automation tool for multi-language software development | boolean | - |
| installMaven | Install Maven, a management tool for Java | boolean | - |
| installGradle | Install Gradle, a build automation tool for multi-language software development | boolean | false |
| installMaven | Install Maven, a management tool for Java | boolean | false |

## License

Expand All @@ -29,4 +29,4 @@ For the Java Feature from this repository, see [NOTICE.txt](https://github.com/d

---

_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/java/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/cmbrose/devcontainer-features/blob/main/src/java/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
4 changes: 2 additions & 2 deletions src/kubectl-helm-minikube/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Installs latest version of kubectl, Helm, and optionally minikube. Auto-detects

```json
"features": {
"ghcr.io/devcontainers/features/kubectl-helm-minikube:1": {
"ghcr.io/cmbrose/devcontainer-features/kubectl-helm-minikube:1": {
"version": "latest"
}
}
Expand Down Expand Up @@ -37,4 +37,4 @@ nohup kubectl port-forward --pod-running-timeout=24h -n ingress-nginx service/in

---

_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/kubectl-helm-minikube/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/cmbrose/devcontainer-features/blob/main/src/kubectl-helm-minikube/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
4 changes: 2 additions & 2 deletions src/node/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Installs Node.js, nvm, yarn, and needed dependencies.

```json
"features": {
"ghcr.io/devcontainers/features/node:1": {
"ghcr.io/cmbrose/devcontainer-features/node:1": {
"version": "latest"
}
}
Expand All @@ -26,4 +26,4 @@ Installs Node.js, nvm, yarn, and needed dependencies.

---

_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/node/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/cmbrose/devcontainer-features/blob/main/src/node/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
8 changes: 4 additions & 4 deletions src/nvidia-cuda/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Installs shared libraries for NVIDIA CUDA.

```json
"features": {
"ghcr.io/devcontainers/features/nvidia-cuda:1": {
"ghcr.io/cmbrose/devcontainer-features/nvidia-cuda:1": {
"version": "latest"
}
}
Expand All @@ -17,8 +17,8 @@ Installs shared libraries for NVIDIA CUDA.

| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| installCudnn | Additionally install CUDA Deep Neural Network (cuDNN) shared library | boolean | - |
| installNvtx | Additionally install NVIDIA Tools Extension (NVTX) | boolean | - |
| installCudnn | Additionally install CUDA Deep Neural Network (cuDNN) shared library | boolean | false |
| installNvtx | Additionally install NVIDIA Tools Extension (NVTX) | boolean | false |
| cudaVersion | Version of CUDA to install | string | 11.7 |
| cudnnVersion | Version of cuDNN to install | string | 8.5.0.96 |

Expand All @@ -45,4 +45,4 @@ Enable GPU passthrough to your devcontainer by adding `["--gpus", "all"]` to you

---

_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/nvidia-cuda/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/cmbrose/devcontainer-features/blob/main/src/nvidia-cuda/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
4 changes: 2 additions & 2 deletions src/oryx/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Installs the oryx CLI

```json
"features": {
"ghcr.io/devcontainers/features/oryx:1": {
"ghcr.io/cmbrose/devcontainer-features/oryx:1": {
"version": "latest"
}
}
Expand All @@ -19,4 +19,4 @@ Installs the oryx CLI

---

_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/oryx/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/cmbrose/devcontainer-features/blob/main/src/oryx/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
4 changes: 2 additions & 2 deletions src/php/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

```json
"features": {
"ghcr.io/devcontainers/features/php:1": {
"ghcr.io/cmbrose/devcontainer-features/php:1": {
"version": "latest"
}
}
Expand All @@ -24,4 +24,4 @@

---

_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/php/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/cmbrose/devcontainer-features/blob/main/src/php/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
4 changes: 2 additions & 2 deletions src/powershell/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Installs PowerShell along with needed dependencies. Useful for base Dockerfiles

```json
"features": {
"ghcr.io/devcontainers/features/powershell:1": {
"ghcr.io/cmbrose/devcontainer-features/powershell:1": {
"version": "latest"
}
}
Expand All @@ -23,4 +23,4 @@ Installs PowerShell along with needed dependencies. Useful for base Dockerfiles

---

_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/powershell/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/cmbrose/devcontainer-features/blob/main/src/powershell/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
Loading