Skip to main content

page_builds

Overview

Namepage_builds
TypeResource
Idgithub.repos.page_builds

Fields

NameDatatypeDescription
errorobject
pusherobjectA GitHub user.
statusstring
updated_atstring
urlstring
commitstring
created_atstring
durationinteger

Methods

NameAccessible byRequired ParamsDescription
get_pages_buildSELECTbuild_id, owner, repoGets information about a GitHub Pages build.

A token with the repo scope is required. GitHub Apps must have the pages:read permission.
list_pages_buildsSELECTowner, repoLists builts of a GitHub Pages site.

A token with the repo scope is required. GitHub Apps must have the pages:read permission.
create_pages_deploymentEXECowner, repo, data__artifact_url, data__oidc_token, data__pages_build_versionCreate a GitHub Pages deployment for a repository.

Users must have write permissions. GitHub Apps must have the pages:write permission to use this endpoint.
request_pages_buildEXECowner, repoYou can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.

Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.