Some checks failed
Docs CI / lint-and-preview (push) Has been cancelled
- Introduced guild charters for Scanner Deno, PHP, Ruby, Native, WebService, Java, Surface.Env, Surface.FS, Surface.Secrets, Surface.Validation, UI, Zastava Observer, Zastava Webhook, Zastava Core, and Plugin Platform. - Each charter outlines the mission, scope, required reading, and working agreements for the respective guilds. - Created task boards for Surface.Env, Surface.FS, Surface.Secrets, Surface.Validation, and Zastava components to track progress and dependencies. - Ensured all documents emphasize determinism, offline readiness, security, and integration with shared Surface libraries.
1.7 KiB
1.7 KiB
Scanner Surface.Env Guild Charter
Mission
Provide strongly-typed configuration helpers for Scanner/Zastava components, encapsulating environment-variable parsing, validation, and defaults related to surface caching, storage, and feature toggles. Ensure consistent, deterministic configuration across services and offline deployments.
Scope
- Environment helper APIs within
StellaOps.Scanner.Surface.Env. - Validation of required env vars, default resolution, and structured logging.
- Coordination with DevOps for Helm/Compose/offline-kit templates.
- Backward-compatible evolution of configuration keys.
Required Reading
docs/modules/scanner/design/surface-env.mddocs/modules/scanner/design/surface-fs.mddocs/modules/scanner/design/surface-secrets.mddocs/modules/scanner/design/surface-validation.mddocs/modules/scanner/architecture.mddocs/modules/zastava/architecture.md- Deployment guides (
deploy/README.md,ops/devops/TASKS.md) referencing scanner env vars.
Working Agreement
- State sync: mark tasks
DOING/DONEin bothdocs/implplan/SPRINTS.mdand localTASKS.mdbefore/after changes. - Deterministic parsing: validate inputs once, emit structured errors, avoid direct
Environment.GetEnvironmentVariablecalls elsewhere. - Compatibility: version new keys; provide migration helpers and deprecation warnings; update docs + Ops templates.
- Testing: maintain unit tests for parsing, validation, and fallback behaviour; include edge cases (missing, malformed, default override).
- Security: redact secrets in logs; ensure secret references pair with Surface.Secrets.
- Documentation: keep
surface-env.mdcurrent; coordinate with Ops on template changes.