Skip to content

docs: Add redaction and allowlist documentation to README#25

Merged
SynthLuvr merged 3 commits into
mainfrom
copilot/update-readme-redacting-allowlist
Feb 27, 2026
Merged

docs: Add redaction and allowlist documentation to README#25
SynthLuvr merged 3 commits into
mainfrom
copilot/update-readme-redacting-allowlist

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 27, 2026

The README had no documentation on automatic secret redaction, how to configure an allowlist, or how to use REDACT_CONFIG. This adds a complete Redacting Sensitive Data section covering all of that.

What's documented

  • Auto-redacted patterns — hex, Base64, Base64url, Base58, BIP39 mnemonics → [REDACTED]
  • setupLogging with RedactConfig — pass allow rules directly at startup
  • Allowlist / context rules — shape of a rule (re, before, after), how context slicing works, and examples showing which values get kept vs. redacted
  • REDACT_CONFIG env var — step-by-step: build JSON → Base64-encode → set env var; clarifies that both sources are merged

Example

// Suppress redaction for known-safe hex contexts
setupLogging({
  hex: { allow: [{ re: /\b(event|transfer)\b/i }] },
});

// Via environment (Base64-encoded JSON):
// {"hex":{"allow":[{"re":"\\b(event)\\b","flags":"i"}]}}
export REDACT_CONFIG="eyJoZXgiOnsiYWxsb3ciOlt7..."

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: SynthLuvr <131367121+SynthLuvr@users.noreply.github.com>
Copilot AI changed the title [WIP] Add redacting and allowlist information to README docs: Add redaction and allowlist documentation to README Feb 27, 2026
@SynthLuvr SynthLuvr marked this pull request as ready for review February 27, 2026 21:01
@SynthLuvr SynthLuvr merged commit 5e5e3f5 into main Feb 27, 2026
3 checks passed
@SynthLuvr SynthLuvr deleted the copilot/update-readme-redacting-allowlist branch February 27, 2026 21:01
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.

2 participants