diff --git a/deprecated/local-mounts/README.md b/deprecated/local-mounts/README.md index 6cfe1be..f39e3b2 100644 --- a/deprecated/local-mounts/README.md +++ b/deprecated/local-mounts/README.md @@ -6,11 +6,11 @@ SPDX-License-Identifier: LGPL-3.0-or-later # Local Mounts — Deprecated -> ⚠️ **This feature has been removed.** It was renamed and superseded by [`dotfiles-sync`](../src/dotfiles-sync/README.md). +> ⚠️ **This feature has been removed.** It was renamed and superseded by [`dotfiles-sync`](../src/dotfiles-sync/). > > Existing images that already pulled `ghcr.io/helpers4/devcontainer/local-mounts:1` keep working from their local cache. New builds referencing this feature will fail to resolve — **you must migrate**. -**Full documentation is preserved on the website:** [helpers4.dev/dev-container/deprecated/local-mounts](https://helpers4.dev/dev-container/deprecated/local-mounts) +**Full documentation is preserved on the website:** [helpers4.dev/devcontainer/deprecated/local-mounts](https://helpers4.dev/devcontainer/deprecated/local-mounts/) ## Migration @@ -25,7 +25,7 @@ Replace the feature reference in your `devcontainer.json`: The `username` option is identical. Runtime behavior is the same, with extra files supported (cargo, pip, yarn, pnpm, gh CLI prefs, …) and opt-in cloud credentials (AWS profiles, kube config, Docker auth, gh OAuth token). -See the [`dotfiles-sync` README](../src/dotfiles-sync/README.md) for full documentation. +See the [`dotfiles-sync` README](../src/dotfiles-sync/) for full documentation. ## Why was it renamed? diff --git a/src/dotfiles-sync/README.md b/src/dotfiles-sync/README.md index 7875fc0..ecb9972 100644 --- a/src/dotfiles-sync/README.md +++ b/src/dotfiles-sync/README.md @@ -33,7 +33,7 @@ That's it. The feature auto-detects the environment and adapts its behavior. | Option | Type | Default | Description | |--------|------|---------|-------------| | `username` | string | `node` | Container username that receives synchronized config files | -| `syncGhAuth` | boolean | `false` | Copy `~/.config/gh/hosts.yml` (GitHub OAuth token used by `gh` CLI) into the container's `$HOME`. Skipped on cloud environments (Codespaces / Gitpod / DevPod inject their own token). When `false`, the file is bind-mounted into `/mnt/h4dotfiles` (Feature `mounts` cannot be conditional) but **never copied** to `$HOME` and never read by anything else. Prefer the [`github-dev`](../github-dev/README.md) feature with `GH_TOKEN` for fine-grained PATs. | +| `syncGhAuth` | boolean | `false` | Copy `~/.config/gh/hosts.yml` (GitHub OAuth token used by `gh` CLI) into the container's `$HOME`. Skipped on cloud environments (Codespaces / Gitpod / DevPod inject their own token). When `false`, the file is bind-mounted into `/mnt/h4dotfiles` (Feature `mounts` cannot be conditional) but **never copied** to `$HOME` and never read by anything else. Prefer the [`github-dev`](../github-dev/) feature with `GH_TOKEN` for fine-grained PATs. | | `syncAwsConfig` | boolean | `false` | Sync `~/.aws/config` (profiles only — `~/.aws/credentials` is **never** synced). | | `syncKubeConfig` | boolean | `false` | Sync `~/.kube/config` (cluster credentials and tokens). Skipped on cloud environments. | | `syncDockerConfig` | boolean | `false` | Sync `~/.docker/config.json` (registry auth tokens). Skipped on cloud environments. | @@ -62,7 +62,7 @@ That's it. The feature auto-detects the environment and adapts its behavior. | Local Path | Option | Notes | |------------|--------|-------| -| `~/.config/gh/hosts.yml` | `syncGhAuth` | GitHub OAuth token used by `gh`. The file is bind-mounted into `/mnt/h4dotfiles` unconditionally (Feature `mounts` cannot be gated on options) but **only copied to `$HOME` when `syncGhAuth: true`**. Skipped on cloud environments. For fine-grained PATs, prefer [`github-dev`](../github-dev/README.md) + `GH_TOKEN`. | +| `~/.config/gh/hosts.yml` | `syncGhAuth` | GitHub OAuth token used by `gh`. The file is bind-mounted into `/mnt/h4dotfiles` unconditionally (Feature `mounts` cannot be gated on options) but **only copied to `$HOME` when `syncGhAuth: true`**. Skipped on cloud environments. For fine-grained PATs, prefer [`github-dev`](../github-dev/) + `GH_TOKEN`. | | `~/.aws/config` | `syncAwsConfig` | AWS profiles. `~/.aws/credentials` (long-lived access keys) is **not bind-mounted** and never synced. | | `~/.kube/config` | `syncKubeConfig` | Kubernetes cluster credentials. Skipped on cloud environments. | | `~/.docker/config.json` | `syncDockerConfig` | Docker registry auth tokens. Skipped on cloud environments. | diff --git a/src/typescript-dev/README.md b/src/typescript-dev/README.md index 1fe54b1..e1c42dc 100644 --- a/src/typescript-dev/README.md +++ b/src/typescript-dev/README.md @@ -125,7 +125,7 @@ This feature pairs perfectly with: - **[essential-dev](../essential-dev)** - Core development tools (required) - **[vite-plus](../vite-plus)** - TypeScript + Vite + Oxc/Vitest toolchain - **[package-auto-install](../package-auto-install)** - Automatic dependency installation -- **[local-mounts](../local-mounts)** - Git/SSH/GPG configuration +- **[local-mounts](../../deprecated/local-mounts/)** - Git/SSH/GPG configuration - **[git-absorb](../git-absorb)** - Commit cleanup tools ## License