saltext.github.utils.gh.statecores.pages¶

State core managing a repository’s GitHub Pages site.

saltext.github.utils.gh.statecores.pages.present(conn, name, repo_name, *, build_type=None, source_branch=None, source_path=None, cname=None, https_enforced=None, owner=None, test=False)[source]¶

Ensure GitHub Pages are enabled for a repository and configured as specified. Unspecified settings are left unmanaged.

conn: GitHubConnection to use.
name: State name (reported back unchanged).
repo_name: Name of the repository.
build_type: Process by which the site is built, either legacy (deploy from a branch) or workflow (GitHub Actions).
source_branch: For legacy builds, the repository branch to publish from.
source_path: For legacy builds, the repository directory to publish from, either / or /docs.
cname: Custom domain for the site.
https_enforced: Enforce HTTPS for the site.
owner: Owner of the repository. Defaults to the connection’s owner.
test: Only project the changes without applying them (test mode).

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

Ensure GitHub Pages are disabled for a repository.

conn: GitHubConnection to use.
name: State name (reported back unchanged).
repo_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).