mirror of
https://github.com/actions/configure-pages.git
synced 2025-12-08 08:06:09 +00:00
406a88e3a9
Based on https://docs.github.com/en/rest/pages?apiVersion=2022-11-28#create-a-github-pages-site Co-authored-by: Yoann Chaudet <yoannchaudet@github.com>
31 lines
1.5 KiB
YAML
31 lines
1.5 KiB
YAML
name: 'Configure GitHub Pages'
|
|
description: 'A GitHub Action to enable Pages, extract various metadata about a site, and configure some supported static site generators.'
|
|
author: 'GitHub'
|
|
runs:
|
|
using: 'node16'
|
|
main: 'dist/index.js'
|
|
inputs:
|
|
static_site_generator:
|
|
description: 'Optional static site generator to attempt to configure: "nuxt", "next", "gatsby", or "sveltekit"'
|
|
required: false
|
|
generator_config_file:
|
|
description: 'Optional file path to static site generator configuration file'
|
|
required: false
|
|
token:
|
|
description: 'GitHub token'
|
|
default: ${{ github.token }}
|
|
required: true
|
|
enablement:
|
|
description: '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.'
|
|
default: 'false'
|
|
required: false
|
|
outputs:
|
|
base_url:
|
|
description: 'GitHub Pages site full base URL. Examples: "https://octocat.github.io/my-repo", "https://octocat.github.io", "https://www.example.com"'
|
|
origin:
|
|
description: 'GitHub Pages site origin. Examples: "https://octocat.github.io", "https://www.example.com"'
|
|
host:
|
|
description: 'GitHub Pages site host. Examples: "octocat.github.io", "www.example.com"'
|
|
base_path:
|
|
description: 'GitHub Pages site full base path. Examples: "/my-repo" or ""'
|