pages

Manage the targeted repository’s GitHub Pages site.

Added in version 1.1.0.

Part of the github resource type: states operate on the repository the state run was dispatched to, so there is no repo_name/owner parameter. The profile parameter defaults to the profile named in the resource declaration.

saltext.github.resources.github.states.pages.present(name, build_type=None, source_branch=None, source_path=None, cname=None, https_enforced=None, profile=None)[source]

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

name

State name (the repository is implied by the resource).

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.

profile

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

saltext.github.resources.github.states.pages.absent(name, profile=None)[source]

Ensure GitHub Pages are disabled for the targeted repository.

name

State name (the repository is implied by the resource).

profile

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