ghaction-github-pages/action.yml

68 lines
1.8 KiB
YAML
Raw Normal View History

2019-09-01 04:23:41 +08:00
# https://help.github.com/en/articles/metadata-syntax-for-github-actions
name: 'GitHub Pages'
2019-10-11 08:25:58 +08:00
description: 'GitHub Action to deploy to GitHub Pages'
2019-09-01 04:23:41 +08:00
author: 'crazy-max'
branding:
color: 'green'
2019-09-01 05:48:53 +08:00
icon: 'upload-cloud'
2019-09-01 04:23:41 +08:00
inputs:
2021-03-16 07:04:53 +08:00
domain:
description: 'Git domain (default github.com)'
required: false
default: 'github.com'
2019-10-03 09:16:44 +08:00
repo:
2021-03-16 07:04:53 +08:00
description: 'GitHub repository where assets will be deployed (default $GITHUB_REPOSITORY)'
2020-05-09 21:17:14 +08:00
required: false
2019-09-01 05:28:00 +08:00
target_branch:
description: 'Git branch where assets will be deployed'
default: 'gh-pages'
2020-05-09 21:17:14 +08:00
required: false
keep_history:
description: 'Create incremental commit instead of doing push force'
default: 'false'
2020-05-09 21:17:14 +08:00
required: false
allow_empty_commit:
description: 'Allow an empty commit to be created'
default: 'true'
2020-05-09 21:17:14 +08:00
required: false
2019-09-01 04:23:41 +08:00
build_dir:
2019-10-11 07:41:16 +08:00
description: 'Build directory to deploy'
2019-09-01 04:23:41 +08:00
required: true
absolute_build_dir:
description: 'Whether to treat build_dir as an absolute path'
default: 'false'
required: false
follow_symlinks:
description: 'If enabled, the content of symbolic links will be copied'
default: 'false'
required: false
committer:
description: 'The committer name and email address'
2020-05-09 21:17:14 +08:00
required: false
author:
description: 'The author name and email address'
2020-05-09 21:17:14 +08:00
required: false
commit_message:
2019-11-06 10:10:09 +08:00
description: 'Commit message'
2020-05-09 21:17:14 +08:00
required: false
fqdn:
description: 'Write the given domain name to the CNAME file'
2020-05-09 21:17:14 +08:00
required: false
jekyll:
description: 'Allow Jekyll to build your site'
default: 'true'
required: false
dry_run:
description: 'If enabled, nothing will be pushed'
default: 'false'
required: false
verbose:
description: 'Enable verbose output'
default: 'false'
required: false
2019-09-01 04:23:41 +08:00
runs:
2023-09-10 02:26:32 +08:00
using: 'node20'
2020-04-09 06:59:11 +08:00
main: 'dist/index.js'