saltext.github.utils.gh.statecores.repo

State core managing a repository’s settings and team associations.

saltext.github.utils.gh.statecores.repo.present(conn, name, *, owner=None, description=None, homepage=None, private=None, has_issues=None, has_wiki=None, has_downloads=None, auto_init=False, gitignore_template=None, license_template=None, default_branch=None, teams=None, allow_privacy_change=False, allow_create=True, test=False)[source]

Ensure a repository is present and configured as specified. Unspecified settings are left unmanaged.

conn

GitHubConnection to use.

name

Name of the repository.

owner

Owner of the repository. Defaults to the connection’s owner.

allow_privacy_change

Allow changing an existing repository’s visibility (the profile’s allow_repo_privacy_changes). Defaults to false.

allow_create

Create the repository when it is missing. When disabled, a missing repository raises instead (resource context, where the repository’s existence is a given). Defaults to true.

test

Only project the changes without applying them (test mode).

For the remaining parameters, see the github_repo.present state.

saltext.github.utils.gh.statecores.repo.absent(conn, name, *, owner=None, test=False)[source]

Ensure a repository is absent.

conn

GitHubConnection to use.

name

Name of the repository.

owner

Owner of the repository. Defaults to the connection’s owner.

test

Only project the changes without applying them (test mode).