Skip to main content

Github Secret

GithubSecret​

An organization-level secret for GitHub Actions.

The engine creates a GitHub Actions organization secret from an inline value or from a Secret manifest. Workflows in all repositories can use it.

PropertyTypeDescription
apiVersionstringAPI schema version. Must be lowops.manifests.v1.
kindstringResource kind. Must be GithubSecret.
metadatamapThe engine reads the reserved keys name and organization to resolve the identity and the parent. The organization label is also part of the computed normalized_name.
specSpecDesired secret definition. See Spec.

Spec​

User-provided secret definition.

Set exactly one of value or value_ref. Validation rejects a manifest that sets both or neither.

PropertyTypeDescription
descriptionstringOptional description of the secret. It is documentation only. The engine does not copy it to the GitHub secret.
valuestringInline plaintext secret value. Use it for non-sensitive values only. For sensitive data use value_ref. Mutually exclusive with value_ref: set exactly one.
valueRefstringName of an organization-level Secret manifest. The engine resolves its payload at execution time and links the manifests. Mutually exclusive with value. The organization Secret that you name here must exist.