pages

Manage the targeted repository’s GitHub Pages site.

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

Return information about the GitHub Pages site of the targeted repository.

CLI Example:

salt 'my-org/my-repo' pages.get

profile

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

saltext.github.resources.github.modules.pages.setup(*, build_type=None, source_branch=None, source_path=None, profile=None)

Configure a GitHub Pages site for the targeted repository. Returns the data of the created site.

CLI Example:

salt 'my-org/my-repo' pages.setup build_type=workflow

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.

profile

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

saltext.github.resources.github.modules.pages.update(*, build_type=None, source_branch=None, source_path=None, cname=Ellipsis, https_enforced=None, profile=None)

Update the GitHub Pages site configuration of the targeted repository.

CLI Example:

salt 'my-org/my-repo' pages.update build_type=workflow

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. Pass null explicitly to remove it, omit to leave it unchanged.

https_enforced

Enforce HTTPS for the site.

profile

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

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

Delete the GitHub Pages site of the targeted repository.

CLI Example:

salt 'my-org/my-repo' pages.remove

profile

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