deploy_key

Manage the targeted repository’s deploy keys.

Added in version 1.1.0.

Part of the github resource type: all functions operate on the repository the job was dispatched to. The profile parameter defaults to the profile named in the resource declaration.

saltext.github.resources.github.modules.deploy_key.list_(*, fields=None, profile=None)

List the deploy keys of the targeted repository.

CLI Example:

salt 'my-org/my-repo' deploy_key.list

fields

Only include these fields in the output. A single field name reduces each entry to the field’s value.

profile

Profile configuration name to use. Defaults to the resource declaration’s profile.

saltext.github.resources.github.modules.deploy_key.get(key_id, *, profile=None)

Return the data of a single deploy key of the targeted repository.

CLI Example:

salt 'my-org/my-repo' deploy_key.get 12345

key_id

ID of the deploy key.

profile

Profile configuration name to use. Defaults to the resource declaration’s profile.

saltext.github.resources.github.modules.deploy_key.add(title, key, *, read_only=False, profile=None)

Add a deploy key to the targeted repository. Returns the data of the created key.

Note

Deploy keys are immutable. To modify one, remove it and add a replacement.

CLI Example:

salt 'my-org/my-repo' deploy_key.add autorelease 'ssh-ed25519 AAAA...' read_only=false

title

Display title of the deploy key.

key

SSH public key.

read_only

Deny write access to the repository for this key. Defaults to false.

profile

Profile configuration name to use. Defaults to the resource declaration’s profile.

saltext.github.resources.github.modules.deploy_key.remove(key_id, *, profile=None)

Remove a deploy key from the targeted repository.

CLI Example:

salt 'my-org/my-repo' deploy_key.remove 12345

key_id

ID of the deploy key.

profile

Profile configuration name to use. Defaults to the resource declaration’s profile.