🔄 Sync updated workspace manifests (#123)

Author: kloud-bot

.vitepress/data/dependencies.yaml

@@ -311,16 +311,6 @@ dependencies:
     package: helm/helm
     version: 4.1.1
 
-  helm-diff:
-    cmd: helm diff version
-    datasource: github-releases
-    group: Docker & Kubernetes
-    home: https://github.com/databus23/helm-diff
-    license: Apache 2
-    package: databus23/helm-diff
-    version: 3.15.0
-    track: false
-
   htop:
     cmd: htop --version
     datasource: deb
@@ -711,7 +701,7 @@ dependencies:
     home: https://github.com/kloudkit/ws-cli
     license: MIT
     package: github.com/kloudkit/ws-cli
-    version: 0.0.48
+    version: 0.0.49
 
   yamllint:
     cmd: yamllint --version

.vitepress/data/env.reference.yaml

@@ -181,6 +181,7 @@ envs:
       additional_vs_extensions_dir:
         type: string
         default: null
+        deprecated: 0.2.0
         reference: /editor/extensions
         example: /additional-extensions
         description: Installs `.vsix` file found in this directory.
@@ -452,10 +453,10 @@ envs:
 
       vault:
         type: string
-        default: null
-        example: /workspace/.ws/vault.yaml
+        default: ~/.ws/vault/secrets.yaml
+        example: /custom/path/vault/secrets.yaml
         since: 0.1.1
-        description: Path to the secrets vault file.
+        description: Path to the secrets vault manifest file.
         longDescription: |
           A YAML file containing encrypted secrets that can be decrypted and
           deployed to various destinations during startup.
@@ -533,6 +534,7 @@ envs:
           When `true`, the autoloader stops at the first failing startup
           or entrypoint and the container startup exits non-zero.
 
+
   terminal:
     properties:
       prompt_hide_docker_context:
@@ -687,6 +689,11 @@ deprecated:
     since: 0.0.20
     removed: 0.1.0
 
+  WS_EDITOR_ADDITIONAL_VS_EXTENSIONS_DIR:
+    since: 0.2.0
+    removed: 0.3.0
+    message: place .vsix files in `~/.ws/extensions/` instead
+
   WS_EXTRA_CA_CERT_ENDPOINTS:
     use: WS_CA_ADDITIONAL_CERT_ENDPOINTS
     since: 0.0.20

.vitepress/data/envs.data.ts

@@ -12,6 +12,7 @@ export interface EnvVar {
   description: string
   longDescription?: string
   since?: string
+  deprecated?: string
   key: string
   md: {
     description: string

.vitepress/theme/components/EnvVarSection.vue

@@ -12,6 +12,7 @@ const anchor = computed(() => env.value.key.toLowerCase().replaceAll('_', '-'))
 <template>
   <h3 :id="anchor" class="header">
     <code>{{ env.key }}</code>
+    <Badge v-if="env.deprecated" type="warning" text="Deprecated" />
 
     <a class="header-anchor" :href="`#${anchor}`" :aria-label="`Permalink to &quot;${env.key}&quot;`"></a>
   </h3>
@@ -33,6 +34,11 @@ const anchor = computed(() => env.value.key.toLowerCase().replaceAll('_', '-'))
       <dt>Since</dt>
       <dd><Badge type="info" :text="`v${env.since}`" /></dd>
     </template>
+
+    <template v-if="env.deprecated">
+      <dt>Deprecated</dt>
+      <dd><Badge type="warning" :text="`v${env.deprecated}`" /></dd>
+    </template>
   </dl>
 
   <div v-if="env.example" v-html="env.md.example" />

docs/editor/extensions.md

@@ -32,27 +32,26 @@ To gain the most from all the new features and upgrades, we suggest using the
 
 ### Install at Boot
 
-Upon startup, Kloud Workspace evaluates several environment variables to automate the
-installation of additional *user-defined* VSCode extensions.
-Both options below can be used in unison:
+Upon startup, Kloud Workspace automatically scans `~/.ws/extensions/` for `.vsix` files
+and installs them.
 
-- <EnvVar group="editor" name="additional_vs_extensions" />
-- <EnvVar group="editor" name="additional_vs_extensions_dir" />
+You can also install additional extensions by marketplace ID:
 
-::: code-group
+- <EnvVar group="editor" name="additional_vs_extensions" />
 
-```sh{2} [list]
+```sh{2}
 docker run \
   -e WS_EDITOR_ADDITIONAL_VS_EXTENSIONS="dbaeumer.vscode-eslint esbenp.prettier-vscode" \
   ghcr.io/kloudkit/workspace:v0.1.2
 ```
 
-```sh{2,3} [directory]
-docker run \
-  -e WS_EDITOR_ADDITIONAL_VS_EXTENSIONS_DIR=/additional-extensions \
-  -v /path/to/my-additional-extensions:/additional-extensions \
-  ghcr.io/kloudkit/workspace:v0.1.2
-```
+::: warning DEPRECATED — `WS_EDITOR_ADDITIONAL_VS_EXTENSIONS_DIR`
+
+`WS_EDITOR_ADDITIONAL_VS_EXTENSIONS_DIR` is deprecated since `v0.2.0` and will be removed
+in `v0.3.0`.
+
+Place your `.vsix` files directly in `~/.ws/extensions/` instead, no environment
+variable required.
 
 :::
 

docs/editor/features.md

@@ -163,10 +163,11 @@ For more information, visit our [contribution guide](/contribute/).
 | `continue`    | cn CLI and continue extension             |           |       |
 | `cpp`         | C++ and related tools                     |           |   ✅   |
 | `dagger`      | dagger.io CLI and SDK                     |           |       |
-| `doctl`       | DigitalOcean CLI                          | *v0.1.3*  |   ✅   |
+| `doctl`       | DigitalOcean CLI                          | *v0.1.3*  |       |
 | `dotnet`      | .NET framework and related extensions     |           |   ✅   |
 | `gcloud`      | Google Cloud CLI for GCP                  |           |   ✅   |
 | `gh`          | GitHub CLI                                |           |   ✅   |
+| `helm-extras` | Helm plugins and related extensions       | *v0.1.3*  |   ✅   |
 | `jf`          | JFrog CLI                                 |           |   ✅   |
 | `jupyter`     | Jupyter packages and related extensions   |           |       |
 | `opencode`    | OpenCode CLI and related extension        | *v0.1.1*  |       |

docs/settings/autoload-scripts.md

@@ -29,19 +29,16 @@ Startup scripts are defined at two levels:
 On startup, the predefined entrypoint scripts stored in `/usr/libexec/workspace/startup.d/*`
 are executed in lexicographical order to initialize the workspace environment.
 
-To add additional functionality during startup, mount your scripts to `/entrypoint/*`.
+To add additional functionality during startup, place executable scripts in
+`~/.ws/startup.d/` *(i.e. `/home/kloud/.ws/startup.d`)*.
+The directories are created automatically on startup.
+
 These scripts are executed as follows:
 
 - Only scripts with an executable file permission *(i.e. `+x`)* are considered.
 - Executed in lexicographical order.
 - Scripts are executed as the `kloud` user.
 
-```sh{2}
-docker run \
-  -v /my-entrypoint-scripts:/entrypoint \
-  ghcr.io/kloudkit/workspace:v0.1.2
-```
-
 ### Available Languages
 
 Feel free to write you entrypoint scripts in the language of your choice, considering it
@@ -67,10 +64,13 @@ Refer to the specific [documentation for `ws-cli`](/tools/ws-cli) for more detai
 
 Similar to entrypoint scripts, the workspace will load startup scripts for every new shell
 session.
-On shell startup, the predefined scripts stored in `/usr/lib/ohmyzsh/custom/*` are executed in
-lexicographical order.
+On shell startup, the predefined scripts stored in `/usr/lib/ohmyzsh/custom/*` are executed
+in lexicographical order.
+
+To add additional functionality during startup, place `.zsh` files in
+`~/.ws/session.d/` *(i.e. `/home/kloud/.ws/session.d`)*.
+The directories are created automatically on startup.
 
-To add additional functionality during startup, mount your scripts to `~/.session/*.zsh`.
 These scripts are executed as follows:
 
 - Both executable and not executable scripts are considered.

docs/settings/secrets.md

@@ -155,10 +155,22 @@ ws secrets vault --input vault.yaml --key database-password --master .master.key
 ws secrets vault --input vault.yaml --stdout --master .master.key
 ```
 
-Vault location can be set via environment variable:
+### Autoloading
+
+At startup the workspace automatically processes `~/.ws/vault/secrets.yaml` when it exists.
+Place your vault manifest and any referenced encrypted files together in that directory:
+
+```text
+~/.ws/vault/
+├── secrets.yaml        # vault manifest
+├── db-password.enc     # encrypted file referenced via file:
+└── ssh-key.enc
+```
+
+To use a different location, set `WS_SECRETS_VAULT`:
 
 ```sh
-export WS_SECRETS_VAULT=/workspace/vault.yaml
+export WS_SECRETS_VAULT=/custom/path/vault/secrets.yaml
 ws secrets vault
 ```
 
@@ -192,7 +204,7 @@ See [authentication documentation](/editor/authentication) for details.
 
 ### Vault Specific Flags
 
-- **`--input <file>`:** Vault file path *(or set `WS_SECRETS_VAULT`)*.
+- **`--input <file>`:** Vault file path *(defaults to `~/.ws/vault/secrets.yaml`; override with `WS_SECRETS_VAULT`)*.
 - **`--key <name>`:** Process specific secret *(repeatable)*.
 - **`--stdout`:** Inspect without writing.
 

scripts/generate-deprecated-variables.mjs

@@ -2,6 +2,19 @@ import fs from 'node:fs'
 import { resolve } from 'node:path'
 import { load } from 'js-yaml'
 
+const replacement = (use, message) => {
+  if (use) {
+    const anchor = use
+      .toLowerCase()
+      .replace(/[^a-z0-9]+/g, '-')
+      .replace(/^-|-$|--+/g, '')
+
+    return `[\`${use}\`](#${anchor})`
+  }
+
+  return message ? `*${message}*` : '—'
+}
+
 const configs = load(
   fs.readFileSync(resolve('.vitepress/data/env.reference.yaml'), 'utf8')
 )
@@ -16,15 +29,10 @@ sections.push(
 Object.keys(configs.deprecated)
   .sort()
   .forEach(env => {
-    const { use, since, removed } = configs.deprecated[env]
-
-    const anchor = use
-      .toLowerCase()
-      .replace(/[^a-z0-9]+/g, '-')
-      .replace(/^-|-$|--+/g, '')
+    const { use, since, removed, message } = configs.deprecated[env]
 
     sections.push(
-      `| ~~*\`${env}\`*~~ | [\`${use}\`](#${anchor}) | *v${since}* | *v${removed}* |`
+      `| ~~*\`${env}\`*~~ | ${replacement(use, message)} | *v${since}* | *v${removed}* |`
     )
   })