ruleset

Manage the targeted repository’s rulesets.

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.ruleset.list_(*, per_page=None, fields=None, profile=None)

List all rulesets of the targeted repository.

CLI Example:

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

per_page

Pagination size, maximum 100.

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.ruleset.get(ruleset_id, *, profile=None)

Return the data of a single ruleset of the targeted repository.

CLI Example:

salt 'my-org/my-repo' ruleset.get 1234

ruleset_id

ID of the ruleset.

profile

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

saltext.github.resources.github.modules.ruleset.add(ruleset_params, *, profile=None)

Create a new ruleset in the targeted repository. Returns the data of the created ruleset.

CLI Example:

salt 'my-org/my-repo' ruleset.add '{name: test, enforcement: active}'

ruleset_params

Ruleset definition. Must contain at least name and enforcement.

profile

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

saltext.github.resources.github.modules.ruleset.update(ruleset_id, ruleset_params, *, profile=None)

Update an existing ruleset of the targeted repository. Returns the data of the updated ruleset.

CLI Example:

salt 'my-org/my-repo' ruleset.update 1234 '{enforcement: disabled}'

ruleset_id

ID of the ruleset.

ruleset_params

Updated ruleset definition.

profile

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

saltext.github.resources.github.modules.ruleset.remove(ruleset_id, *, profile=None)

Delete a ruleset from the targeted repository.

CLI Example:

salt 'my-org/my-repo' ruleset.remove 1234

ruleset_id

ID of the ruleset.

profile

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