docs(ci): finalize global install runtime docs and smoke coverage
This commit is contained in:
parent
8df567c327
commit
6fbd6329b4
6 changed files with 157 additions and 1 deletions
|
|
@ -41,9 +41,14 @@ Legacy repo-bound shim migration is required:
|
|||
- Rewrite shims to runtime-managed targets atomically.
|
||||
- Preserve user-facing command names and shell compatibility.
|
||||
|
||||
## Supported Platforms
|
||||
|
||||
- Linux: npm-global primary, POSIX wrapper fallback.
|
||||
- macOS: npm-global primary, POSIX wrapper fallback.
|
||||
- Windows: npm-global primary, PowerShell wrapper fallback.
|
||||
|
||||
## Failure Modes and Rollback
|
||||
|
||||
- Missing runtime metadata: launcher reports actionable remediation and install mode.
|
||||
- Corrupt runtime target: launcher falls back to previous known-good metadata when present.
|
||||
- Partial install: installer leaves active runtime unchanged and exits non-zero.
|
||||
|
||||
|
|
|
|||
31
docs/ops/global-install-rollout.md
Normal file
31
docs/ops/global-install-rollout.md
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
# Global Install Rollout: Runtime Manager
|
||||
|
||||
## Objective
|
||||
Roll out npm-global-first install behavior with runtime metadata and backward-compatible shim migration.
|
||||
|
||||
## Operator Install Paths
|
||||
1. Primary: `npm i -g beadboard`
|
||||
2. Fallback (POSIX): `bash ./install/install.sh`
|
||||
3. Fallback (Windows): `powershell -ExecutionPolicy Bypass -File .\\install\\install.ps1`
|
||||
|
||||
## Runtime Layout
|
||||
- Shim directory: `~/.beadboard/bin`
|
||||
- Runtime versions: `~/.beadboard/runtime/<version>`
|
||||
- Active runtime metadata: `~/.beadboard/runtime/current.json`
|
||||
|
||||
## Migration
|
||||
When existing repo-bound shims are found, installers rewrite them to runtime-aware shims that resolve runtime root from `current.json` first.
|
||||
|
||||
## Recovery Playbook
|
||||
1. Run `beadboard doctor --json`.
|
||||
2. If metadata missing/corrupt, rerun installer fallback for your platform.
|
||||
3. If PATH missing, add `~/.beadboard/bin` to PATH.
|
||||
4. If repo-bound shim remains, rerun installer to force shim rewrite.
|
||||
|
||||
## Platform Matrix
|
||||
- Linux: Supported
|
||||
- macOS: Supported
|
||||
- Windows: Supported
|
||||
|
||||
## CI Validation
|
||||
Installer smoke workflow validates wrapper execution and `beadboard doctor --json` in Ubuntu and Windows jobs.
|
||||
Loading…
Add table
Add a link
Reference in a new issue