Skip to content

codespaces_secret.md

Latest commit

 

History

History
60 lines (45 loc) · 1.91 KB

codespaces_secret.md

File metadata and controls

60 lines (45 loc) · 1.91 KB
Raw

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

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

The codespaces secret value can be resolved via a credential provider. The supported format is <credential_provider>:<provider specific data>.

  • Bitwarden: bitwarden:<bitwarden item id>@<custom_field_key>

    "secret": "bitwarden:118276ad-158c-4720-b68d-af8c00fe3481@secret"

  • Pass: pass:<path/to/secret>

    "secret": "pass:path/to/repo/secret"

!!! note

After executing an `import` operation, the codespaces secret will be set to `********` as GitHub will not disclose the
secret value anymore via its API. You will need to update the configuration with the real secret value, either
by entering the secret value (not advised), or referencing it via a credential provider.

Secrets which have a redacted value defined will be skipped during processing.

Jsonnet Function

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

Validation rules

  • redacted dependabot secret values (********) trigger a validation info and will skip the secret during processing

Example usage

=== "jsonnet" jsonnet orgs.newOrg('OtterdogTest') { ... _repositories+:: [ ... orgs.newRepo('test-repo') { ... codespaces_secrets+: [ orgs.newRepoCodespacesSecret('TEST_CODESPACES_SECRET') { value: "pass:path/to/secret", }, ], } ] }