Read a repo's GitHub Pages status

Check a repository’s current Pages configuration and build status.

Call

get_pages_config { "owner": "<owner>", "repo": "<repo>" }

Result

{
  "url": "https://api.github.com/repos/<owner>/<repo>/pages",
  "status": "built",
  "buildType": "workflow",
  "htmlUrl": "https://<owner>.github.io/<repo>/"
}

status is null while a build is in progress or hasn’t run yet; url/htmlUrl are null if Pages isn’t enabled at all.

If Pages isn’t enabled

Expect a github_api_error — GitHub’s Pages endpoint 404s for a repo with no Pages site configured, the same way branch-protection’s endpoint 404s for an unprotected branch.

Notes

Read-only: this plugin does not enable, disable, or reconfigure Pages — only reports its current state. That’s deliberate; changing a repo’s live site is a risk this domain’s scoping doesn’t take on. To actually enable or reconfigure Pages, use the GitHub web UI or the REST API’s write endpoints directly.