Skip to content

docs(deploy): document safe redaction for support logs - #565

Merged
karagozemin merged 1 commit into
Sub-Rosa-Issue:mainfrom
umpireboulianne-design:fix/issue-547
Oct 27, 2026
Merged

karagozemin merged 1 commit into
Sub-Rosa-Issue:mainfrom
umpireboulianne-design:fix/issue-547

Conversation

@umpireboulianne-design

Copy link
Copy Markdown
Contributor

Summary

  • Add a ## Support log redaction & troubleshooting section to docs/DEPLOY.md listing the credentials, headers, session keys, and pre-reveal bid values/nonces that must be removed from keeper (services/keeper), appraisal API (services/appraisal-api), SDK/relayer (packages/sdk), and browser/DevTools (apps/web) logs before sharing.
  • Add an automated test in scripts/check-deploy-docs.test.mjs verifying that docs/DEPLOY.md documents all four log surfaces and the required redaction fields while keeping node scripts/check-deploy-docs.mjs green.

Supply-chain review

  • No package scripts or dependencies changed. If changed, explain why below.
  • No .vscode/, workflow, or other editor/config file changes. If changed, list them below.
  • No lockfile changes. If changed, explain the update below.
  • No binary or font asset changes. If changed, list and justify them below.
  • I confirm no automatic task (such as preinstall/postinstall) was added.
  • I confirm no hidden executable payload (encoded blob, obfuscated command, or unexpected binary) was added.
  • Any changed executable or binary was reviewed by a maintainer.

Testing

  • node scripts/check-deploy-docs.mjs (passes)
  • node --test scripts/check-deploy-docs.test.mjs (8/8 tests pass)
  • node scripts/check-links.js (passes)

Closes #547
Fixes #547

@karagozemin
karagozemin merged commit 2499a75 into Sub-Rosa-Issue:main Oct 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(high/easy): document safe redaction for support logs

2 participants