From ee516c020b27498cb78f2fea5427055e9546b260 Mon Sep 17 00:00:00 2001 From: Marcin Tojek Date: Wed, 5 Jun 2024 11:41:55 +0200 Subject: [PATCH 1/3] docs: document unsupported features --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 677fb206..cdd608dc 100644 --- a/README.md +++ b/README.md @@ -285,6 +285,23 @@ docker run -it --rm \ - [`ENVBUILDER_SSL_CERT_DIR`](https://go.dev/src/crypto/x509/root_unix.go#L25): Identifies which directory to check for SSL certificate files. - `ENVBUILDER_SSL_CERT_BASE64`: Specifies a base64-encoded SSL certificate that will be added to the global certificate pool on start. +## Unsupported features + +### Development Containers + +| Name | Description | Known issues | +| ------------------------ | ------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------- | +| Volume mounts | Volumes are used to persist data and share directories between the host and container. | TODO | +| Port forwarding | Port forwarding allows exposing container ports to the host, making services accessible. | [#48](https://github.com/coder/envbuilder/issues/48) | +| Script init & Entrypoint | `init` adds a tiny init process to the container and `entrypoint` sets a script to run at container startup. | TODO | +| Customizations | Product specific properties, for instance: _VS Code_ `settings` and `extensions`. | [#43](https://github.com/coder/envbuilder/issues/43) | + +### Devfile + +> [Devfiles](https://devfile.io/) automate and simplify development process by adopting the existing devfiles that are available in the [public community registry](https://registry.devfile.io/viewer). + +Issue: [#113](https://github.com/coder/envbuilder/issues/113) + # Local Development Building `envbuilder` currently **requires** a Linux system. From add6b5bbff91235dc221ae9c8f8c4e61cfc74243 Mon Sep 17 00:00:00 2001 From: Marcin Tojek Date: Wed, 5 Jun 2024 11:55:58 +0200 Subject: [PATCH 2/3] Notice --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index cdd608dc..0937bd08 100644 --- a/README.md +++ b/README.md @@ -289,6 +289,8 @@ docker run -it --rm \ ### Development Containers +The table keeps track of features we would love to implement. Feel free to [create a new issue](https://github.com/coder/envbuilder/issues/new) if you want Envbuilder to support it. + | Name | Description | Known issues | | ------------------------ | ------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------- | | Volume mounts | Volumes are used to persist data and share directories between the host and container. | TODO | From 98d446ef6b913ebd110d10a7ebf22a89788c7c3d Mon Sep 17 00:00:00 2001 From: Marcin Tojek Date: Wed, 5 Jun 2024 12:01:17 +0200 Subject: [PATCH 3/3] links --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0937bd08..11d3bcc1 100644 --- a/README.md +++ b/README.md @@ -291,12 +291,12 @@ docker run -it --rm \ The table keeps track of features we would love to implement. Feel free to [create a new issue](https://github.com/coder/envbuilder/issues/new) if you want Envbuilder to support it. -| Name | Description | Known issues | -| ------------------------ | ------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------- | -| Volume mounts | Volumes are used to persist data and share directories between the host and container. | TODO | -| Port forwarding | Port forwarding allows exposing container ports to the host, making services accessible. | [#48](https://github.com/coder/envbuilder/issues/48) | -| Script init & Entrypoint | `init` adds a tiny init process to the container and `entrypoint` sets a script to run at container startup. | TODO | -| Customizations | Product specific properties, for instance: _VS Code_ `settings` and `extensions`. | [#43](https://github.com/coder/envbuilder/issues/43) | +| Name | Description | Known issues | +| ------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------ | +| Volume mounts | Volumes are used to persist data and share directories between the host and container. | [#220](https://github.com/coder/envbuilder/issues/220) | +| Port forwarding | Port forwarding allows exposing container ports to the host, making services accessible. | [#48](https://github.com/coder/envbuilder/issues/48) | +| Script init & Entrypoint | `init` adds a tiny init process to the container and `entrypoint` sets a script to run at container startup. | [#221](https://github.com/coder/envbuilder/issues/221) | +| Customizations | Product specific properties, for instance: _VS Code_ `settings` and `extensions`. | [#43](https://github.com/coder/envbuilder/issues/43) | ### Devfile