mirror of
https://github.com/actions/deploy-pages.git
synced 2025-12-08 16:16:16 +00:00
44 lines
1.7 KiB
YAML
44 lines
1.7 KiB
YAML
name: 'Deploy GitHub Pages site'
|
|
description: 'A GitHub Action to deploy an artifact as a GitHub Pages site'
|
|
author: 'GitHub'
|
|
runs:
|
|
using: 'node16'
|
|
main: 'dist/index.js'
|
|
inputs:
|
|
emit_telemetry:
|
|
deprecationMessage: 'Use of this input causes the action to do nothing. You should remove this build step from your workflow.'
|
|
description: 'Should this action only emit build telemetry instead of deploying the build artifact?'
|
|
required: false
|
|
default: 'false'
|
|
conclusion:
|
|
deprecationMessage: 'Use of this input does nothing as it was part of the deprecated `emit_telemetry` flow. You should remove this parameter from your workflow.'
|
|
description: 'The status of the previous build.'
|
|
required: false
|
|
token:
|
|
description: 'GitHub token'
|
|
default: ${{ github.token }}
|
|
required: true
|
|
timeout:
|
|
description: 'Time in milliseconds after which to timeout and cancel the deployment (default: 10 minutes)'
|
|
required: false
|
|
default: '600000'
|
|
error_count:
|
|
description: 'Maximum number of status report errors before cancelling a deployment (default: 10)'
|
|
required: false
|
|
default: '10'
|
|
reporting_interval:
|
|
description: 'Time in milliseconds between two deployment status report (default: 5 seconds)'
|
|
required: false
|
|
default: '5000'
|
|
artifact_name:
|
|
description: 'Name of the artifact to deploy'
|
|
required: false
|
|
default: 'github-pages'
|
|
preview:
|
|
description: 'Is this attempting to deploy a pull request as a GitHub Pages preview site? (NOTE: This feature is only in alpha currently and is not available to the public!)'
|
|
required: false
|
|
default: 'false'
|
|
outputs:
|
|
page_url:
|
|
description: 'URL to deployed GitHub Pages'
|