docs(data-analytics-demo): align ADR-0070 + README with shipped env-var contract#93
Merged
Merged
Conversation
…ar contract Closes the AC-γ.3 drift surfaced by 2026-05-18 objective review: - ADR-0070 L62 previously stated `.env.example ships placeholders only (deferred to T-03)`, but no `.env.example` was ever shipped (Security Master Layer 6 blocks the `.env*` filename pattern by design). - The package's env-var surface (DEMO_* seed + row counts, OLLAMA_HOST / MODEL, prohibited cloud-LLM credentials) is genuinely documented; it just had no single source of truth. This commit: - Adds an "Environment variables" table to packages/data-analytics-demo/README.md (defaults match in-code constants; prohibited cloud-LLM credential list mirrors `ollama_client.EXTERNAL_API_ENV_VARS` exactly). - Rewrites ADR-0070 security-mitigations bullet to reference the README section and enumerate the AC-4.3 fail-stop credential list explicitly. Verify: - ruff + mypy --strict: clean - pytest: 36 PASS, coverage 87.20% - doc-drift: 0 failure - adr-claims: 77/77 PASS
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
leagames0221-sys
added a commit
that referenced
this pull request
May 21, 2026
…ar contract (#93) Closes the AC-γ.3 drift surfaced by 2026-05-18 objective review: - ADR-0070 L62 previously stated `.env.example ships placeholders only (deferred to T-03)`, but no `.env.example` was ever shipped (Security Master Layer 6 blocks the `.env*` filename pattern by design). - The package's env-var surface (DEMO_* seed + row counts, OLLAMA_HOST / MODEL, prohibited cloud-LLM credentials) is genuinely documented; it just had no single source of truth. This commit: - Adds an "Environment variables" table to packages/data-analytics-demo/README.md (defaults match in-code constants; prohibited cloud-LLM credential list mirrors `ollama_client.EXTERNAL_API_ENV_VARS` exactly). - Rewrites ADR-0070 security-mitigations bullet to reference the README section and enumerate the AC-4.3 fail-stop credential list explicitly. Verify: - ruff + mypy --strict: clean - pytest: 36 PASS, coverage 87.20% - doc-drift: 0 failure - adr-claims: 77/77 PASS Co-authored-by: leagames0221-sys <leagames0221@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
@craftstack/data-analytics-demo0.1.0..env.example ships placeholders only (deferred to T-03), but no.env.examplewas ever shipped (.env*is blocked by the user's Security Master Layer 6 credential-leak guard by design).DEMO_RANDOM_SEED,DEMO_N_CUSTOMERS/SUBSCRIPTIONS/EVENTS/INVOICES,OLLAMA_HOST,OLLAMA_MODEL, plus the AC-4.3 prohibited cloud-LLM key list) is now documented insidepackages/data-analytics-demo/README.mdas a single source of truth; ADR-0070 points at it.What changed
packages/data-analytics-demo/README.md— new Environment variables section (table of 7 supported vars with in-code defaults + explicit prohibited-credential list mirroringollama_client.EXTERNAL_API_ENV_VARS).docs/adr/0070-data-analytics-demo-polyglot-adoption.md— security-mitigations bullet rewritten to reference the README section and enumerate the AC-4.3 fail-stop credentials explicitly. No tradeoff or decision is altered.No source / test / Makefile / CI / pyproject change. Defaults are unchanged; behavior is unchanged.
Test plan
ruff check src tests→ All checks passedmypy -p data_analytics_demo→ no issues (21 files)pytest→ 36 PASS, coverage 87.20% (≥ 80% floor)node scripts/check-doc-drift.mjs→ 0 failurenode scripts/check-adr-claims.mjs→ 77/77 PASS