2022-08-10 12:59:11 -05:00
name : 'Deploy GitHub Pages site'
description : 'A GitHub Action to deploy an artifact as a GitHub Pages site'
2022-08-09 22:15:35 -05:00
author : 'GitHub'
2021-12-13 23:03:09 -05:00
runs :
2025-07-29 13:52:03 +01:00
using : 'node24'
2021-12-13 23:03:09 -05:00
main : 'dist/index.js'
inputs :
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
2022-09-09 17:09:19 -05:00
default : '600000'
2021-12-13 23:03:09 -05:00
error_count :
description: 'Maximum number of status report errors before cancelling a deployment (default : 10 )'
required : false
2022-09-09 17:09:19 -05:00
default : '10'
2021-12-13 23:03:09 -05:00
reporting_interval :
2022-04-11 14:29:33 -04:00
description: 'Time in milliseconds between two deployment status report (default : 5 seconds)'
2021-12-13 23:03:09 -05:00
required : false
2022-09-09 17:09:19 -05:00
default : '5000'
2022-08-04 15:43:58 -07:00
artifact_name :
description : 'Name of the artifact to deploy'
required : false
2022-09-09 17:09:19 -05:00
default : 'github-pages'
2022-09-09 17:08:16 -05:00
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'
2021-12-22 10:56:47 -08:00
outputs :
page_url :
2022-04-11 14:30:09 -04:00
description : 'URL to deployed GitHub Pages'
