Files
git.stella-ops.org/src/Scanner/__Libraries/StellaOps.Scanner.Surface.Env/AGENTS.md
master 66cb6c4b8a
Some checks failed
Docs CI / lint-and-preview (push) Has been cancelled
feat: Add guild charters and task boards for various components
- 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.
2025-11-01 02:21:46 +02:00

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.md
  • docs/modules/scanner/design/surface-fs.md
  • docs/modules/scanner/design/surface-secrets.md
  • docs/modules/scanner/design/surface-validation.md
  • docs/modules/scanner/architecture.md
  • docs/modules/zastava/architecture.md
  • Deployment guides (deploy/README.md, ops/devops/TASKS.md) referencing scanner env vars.

Working Agreement

  1. State sync: mark tasks DOING/DONE in both docs/implplan/SPRINTS.md and local TASKS.md before/after changes.
  2. Deterministic parsing: validate inputs once, emit structured errors, avoid direct Environment.GetEnvironmentVariable calls elsewhere.
  3. Compatibility: version new keys; provide migration helpers and deprecation warnings; update docs + Ops templates.
  4. Testing: maintain unit tests for parsing, validation, and fallback behaviour; include edge cases (missing, malformed, default override).
  5. Security: redact secrets in logs; ensure secret references pair with Surface.Secrets.
  6. Documentation: keep surface-env.md current; coordinate with Ops on template changes.