actions-marketplace-validations/Configure GitHub Pages
A GitHub Action to enable Pages, extract various metadata about a site, and configure some supported static site generators.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| static_site_generator | Optional static site generator to attempt to configure: "nuxt", "next", "gatsby", or "sveltekit" | no | — |
| generator_config_file | Optional file path to static site generator configuration file | no | — |
| token | GitHub token | yes | ${{ github.token }} |
| enablement | Try 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. | no | false |
Outputs
| name | description |
|---|---|
| base_url | GitHub Pages site full base URL. Examples: "https://octocat.github.io/my-repo", "https://octocat.github.io", "https://www.example.com" |
| origin | GitHub Pages site origin. Examples: "https://octocat.github.io", "https://www.example.com" |
| host | GitHub Pages site host. Examples: "octocat.github.io", "www.example.com" |
| base_path | GitHub Pages site full base path. Examples: "/my-repo" or "" |