Skip to content

Environment Secret

Definition of a Secret on environment level, the following properties are supported:

Key Value Description Note
name string The name of the secret
value SecretValue The secret value

The value should reference a credential provider instead of being written in clear text, see SecretValue.

Jsonnet Function

orgs.newEnvSecret('<name>') {
  <key>: <value>
}

Validation rules

  • a name that is not uppercase triggers an error, as GitHub normalizes secret names to uppercase
  • redacted secret values (********) trigger a validation info and will skip the secret during processing

Example usage

orgs.newOrg('OtterdogTest') {
  ...
  _repositories+:: [
    ...
    orgs.newRepo('test-repo') {
      ...
      environments: [
        orgs.newEnvironment('linux') {
          ...
          secrets+: [
            orgs.newEnvSecret('TEST_SECRET') {
              value: "pass:path/to/secret",
            },
          ],
        },
      ]
    }
  ]
}