Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 4 additions & 3 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@
"name": "TheDiveO's devcontainer features",
"image": "mcr.microsoft.com/devcontainers/base:ubuntu",
"features": {
"ghcr.io/thediveo/devcontainer-features/pinact:0": {},
"ghcr.io/thediveo/devcontainer-features/lazygit:0": {},
"ghcr.io/thediveo/devcontainer-features/pinact:0": {},
"ghcr.io/devcontainers/features/node:2": {},
"./devcontainers-cli": {},
"ghcr.io/devcontainers/features/docker-in-docker:3": {
"./devcontainers-cli": {}, // installs devcontainer CLI, needs some node
"ghcr.io/devcontainers/features/docker-in-docker:4": {
"version": "latest",
"moby": false // go for the upstream Docker-CE
},
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
packages: write

steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0

- name: "publish Features"
uses: devcontainers/action@1082abd5d2bf3a11abccba70eef98df068277772 # v1.4.3
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ jobs:
baseImage:
- mcr.microsoft.com/devcontainers/base:ubuntu
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0

- name: "install latest devcontainer CLI"
run: npm install -g @devcontainers/cli@0.84.1
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/validate.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
validate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0

- name: "validate devcontainer-feature.json files"
uses: devcontainers/action@1082abd5d2bf3a11abccba70eef98df068277772 # v1.4.3
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Container feature that also doesn't support Alpine.
upstream https://github.com/containernetworking/plugins binary releases.

- [docsify](src/docsify/README.md) – automatically serves ./docs workspace
directory via `docsify serve` in the background (with the specific workspace
directory via `browser-sync` in the background (with the specific workspace
location being configurable).

- [gcx](src/gcx/README.md) – installs `gcx` directly from upstream
Expand Down
17 changes: 17 additions & 0 deletions src/docsify/NOTES.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
## Feature Dependency

This feature has a soft dependency on `ghcr.io/devcontainers/features/node` –
depending on you base image you already have a suitable node, otherwise you
might want to also reference the above node feature.

For example:

```json
{
"features": {
"ghcr.io/devcontainers/features/node:2": {}, // unless base image has node
"ghcr.io/thediveo/devcontainer-features/docsify:1": {}
}
}
```

## Docs Directory

If the directory configured in the `docs-path` option does not exist, it is
Expand Down
17 changes: 17 additions & 0 deletions src/docsify/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,23 @@ Automatically serves ./docs (or another) workspace directory via 'browser-sync'
| reload-delay | time in milliseconds to delay the reload event following file changes | string | 2000 |
| reload-debounce | time in milliseconds to restrict the frequency in which browser:reload events can be emitted to connected clients | string | 5000 |

## Feature Dependency

This feature has a soft dependency on `ghcr.io/devcontainers/features/node` –
depending on you base image you already have a suitable node, otherwise you
might want to also reference the above node feature.

For example:

```json
{
"features": {
"ghcr.io/devcontainers/features/node:2": {}, // unless base image has node
"ghcr.io/thediveo/devcontainer-features/docsify:1": {}
}
}
```

## Docs Directory

If the directory configured in the `docs-path` option does not exist, it is
Expand Down
2 changes: 1 addition & 1 deletion src/docsify/devcontainer-feature.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "docsify server",
"id": "docsify",
"version": "1.0.0",
"version": "1.0.1",
"description": "Automatically serves ./docs (or another) workspace directory via 'browser-sync' in the background.",
"options": {
"port": {
Expand Down
9 changes: 4 additions & 5 deletions src/local-pkgsite/NOTES.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,19 @@
## Feature Dependency

This feature has only a soft dependecy on `ghcr.io/devcontainers/features/go` so
that you have full control over from where and how you bring in the go
toolchain.
This feature has a soft dependecy on `ghcr.io/devcontainers/features/go` so that
you have full control over from where and how you bring in the go toolchain.

Similar, it has a soft dependency on `ghcr.io/devcontainers/features/node` –
depending on you base image you already have a suitable node, otherwise you
might want to use the aforementioned node feature.
might want to also reference the above node feature.

For example:

```json
{
"features": {
"ghcr.io/devcontainers/features/go:1": {},
"ghcr.io/devcontainers/features/node:2": {}, // optional
"ghcr.io/devcontainers/features/node:2": {}, // unless base image has node
"ghcr.io/thediveo/devcontainer-features/local-pkgsite:1": {}
}
}
Expand Down
9 changes: 4 additions & 5 deletions src/local-pkgsite/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,20 @@ A local Go pkgsite serving the module documentation, with automatic browser refr

## Feature Dependency

This feature has only a soft dependecy on `ghcr.io/devcontainers/features/go` so
that you have full control over from where and how you bring in the go
toolchain.
This feature has a soft dependecy on `ghcr.io/devcontainers/features/go` so that
you have full control over from where and how you bring in the go toolchain.

Similar, it has a soft dependency on `ghcr.io/devcontainers/features/node` –
depending on you base image you already have a suitable node, otherwise you
might want to use the aforementioned node feature.
might want to also reference the above node feature.

For example:

```json
{
"features": {
"ghcr.io/devcontainers/features/go:1": {},
"ghcr.io/devcontainers/features/node:2": {}, // optional
"ghcr.io/devcontainers/features/node:2": {}, // unless base image has node
"ghcr.io/thediveo/devcontainer-features/local-pkgsite:1": {}
}
}
Expand Down
2 changes: 1 addition & 1 deletion src/local-pkgsite/devcontainer-feature.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "Local Go Pkgsite",
"id": "local-pkgsite",
"version": "1.0.1",
"version": "1.0.2",
"description": "A local Go pkgsite serving the module documentation, with automatic browser refresh.",
"options": {
"port": {
Expand Down
4 changes: 4 additions & 0 deletions test/nerdctl/debian.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ set -e

source dev-container-features-test-lib

ls -l /run
sudo ls -l /run/docker
sudo ls -l /run/containerd

# as we're combining this test with docker-in-docker, containerd's socket isn't
# in its default location and we explicitly specify it in this feature's options
# (whalewatchers: hold my beer...)
Expand Down
5 changes: 2 additions & 3 deletions test/nerdctl/scenarios.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,13 @@
"debian": {
"image": "mcr.microsoft.com/devcontainers/base:debian-13",
"features": {
"ghcr.io/devcontainers/features/docker-in-docker:3": {
"ghcr.io/devcontainers/features/docker-in-docker:4": {
"moby": false,
"dockerDashComposeVersion": "none",
"installDockerBuildx": false
},
"nerdctl": {
"cni-path": "/usr/local/bin/cni",
"containerd-api": "unix:///run/docker/containerd/containerd.sock"
"cni-path": "/usr/local/bin/cni"
}
}
},
Expand Down
6 changes: 3 additions & 3 deletions test/pull-through-cache-registry/scenarios.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"default": {
"image": "mcr.microsoft.com/devcontainers/base:ubuntu",
"features": {
"ghcr.io/devcontainers/features/docker-in-docker:3": {
"ghcr.io/devcontainers/features/docker-in-docker:4": {
"moby": false
},
"pull-through-cache-registry": {}
Expand All @@ -11,7 +11,7 @@
"9999": {
"image": "mcr.microsoft.com/devcontainers/base:ubuntu",
"features": {
"ghcr.io/devcontainers/features/docker-in-docker:3": {
"ghcr.io/devcontainers/features/docker-in-docker:4": {
"moby": false
},
"pull-through-cache-registry": {
Expand All @@ -22,7 +22,7 @@
"quay.io": {
"image": "mcr.microsoft.com/devcontainers/base:ubuntu",
"features": {
"ghcr.io/devcontainers/features/docker-in-docker:3": {
"ghcr.io/devcontainers/features/docker-in-docker:4": {
"moby": false
},
"pull-through-cache-registry": {
Expand Down
Loading