actions/Configure GitHub Pages

A GitHub Action to enable Pages, extract various metadata about a site, and configure some supported static site generators.

View on GitHub

Trust Signals

Scorecard Score
Scorecard 6–8scored Jul 6, 2026
Maintenance Recency
Activelast commit Mar 24, 2026
License
MIT

Pinned Snippet

workflow.ymlSHA-pinned
uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
static_site_generatorOptional static site generator to attempt to configure: "nuxt", "next", "gatsby", or "sveltekit"no
generator_config_fileOptional file path to static site generator configuration fileno
tokenGitHub tokenyes${{ github.token }}
enablementTry to enable Pages for the repository if it is not already enabled. This option requires a token other than `GITHUB_TOKEN` to be provided. In the context of a Personal Access Token, the `repo` scope or Pages write permission is required. In the context of a GitHub App, the `administration:write` and `pages:write` permissions are required.nofalse
namedescription
base_urlGitHub Pages site full base URL. Examples: "https://octocat.github.io/my-repo", "https://octocat.github.io", "https://www.example.com"
originGitHub Pages site origin. Examples: "https://octocat.github.io", "https://www.example.com"
hostGitHub Pages site host. Examples: "octocat.github.io", "www.example.com"
base_pathGitHub Pages site full base path. Examples: "/my-repo" or ""