Skip to content

secrets.yml

Secret declarations for ${{ secrets.* }}. Each entry takes one of three forms:

# Declared, no value: resolves from your environment at run time
NPM_TOKEN:
# Literal value (local-only)
DEPLOY_KEY: "***local-value***"
# Full form
SENTRY_DSN:
description: Crash reporting DSN for the staging project
required: true
value: "***local-value***"

At run time a secret resolves from the file value first, then from process.env. A required secret with no value anywhere fails pre-run validation.

  • The scaffolded .overwire/.gitignore ignores secrets.yml, so values stay out of git.
  • Step output capture is redacted by default, even in live mode.
  • The desktop app warns when a secrets.yml holding literal values would be committable, and offers to fix the ignore rule. It can also store values encrypted in the OS keychain instead of the file (Settings).
  • The renderer process of the desktop app never sees plaintext values, only name and has-value metadata.

overwire.io

Overwire is not affiliated with, endorsed by, or sponsored by GitHub, Inc., Microsoft Corporation, or Docker, Inc. GitHub and GitHub Actions are trademarks of GitHub, Inc.