actions-gh-pages/action.yml

80 lines
2.5 KiB
YAML
Raw Normal View History

2020-02-05 05:40:07 +00:00
name: 'GitHub Pages action'
2019-10-03 02:31:57 +00:00
description: 'GitHub Actions for GitHub Pages 🚀 Deploy static files and publish your site easily. Static-Site-Generators-friendly.'
author: 'peaceiris'
runs:
using: 'node12'
main: 'lib/index.js'
branding:
icon: 'upload-cloud'
color: 'blue'
inputs:
deploy_key:
2020-03-09 12:45:20 +00:00
description: 'Set a SSH private key from repository secret value for pushing to the remote branch.'
required: false
github_token:
2020-03-09 12:45:20 +00:00
description: 'Set a generated GITHUB_TOKEN for pushing to the remote branch.'
required: false
personal_token:
2020-03-09 12:45:20 +00:00
description: 'Set a personal access token for pushing to the remote branch.'
required: false
publish_branch:
2020-03-09 12:45:20 +00:00
description: 'Set a target branch for deployment.'
required: false
default: 'gh-pages'
publish_dir:
2020-03-09 12:45:20 +00:00
description: 'Set an input directory for deployment.'
required: false
default: 'public'
destination_dir:
description: 'Set an destination subdirectory for deployment.'
required: false
default: ''
external_repository:
2020-03-09 12:45:20 +00:00
description: 'Set an external repository (owner/repo).'
required: false
allow_empty_commit:
description: 'If empty commits should be made to the publication branch'
required: false
default: 'false'
keep_files:
2019-09-24 17:41:21 +00:00
description: 'If existing files in the publish branch should be not removed before deploying'
required: false
2019-10-03 02:31:57 +00:00
default: 'false'
force_orphan:
description: 'Keep only the latest commit on a GitHub Pages branch'
required: false
default: 'false'
user_name:
description: 'Set Git user.name'
required: false
user_email:
description: 'Set Git user.email'
required: false
commit_message:
description: 'Set a custom commit message with a triggered commit hash'
required: false
full_commit_message:
description: 'Set a custom full commit message without a triggered commit hash'
required: false
tag_name:
description: 'Set tag name'
required: false
tag_message:
description: 'Set tag message'
required: false
enable_jekyll:
description: 'Enable the GitHub Pages built-in Jekyll'
required: false
default: 'false'
disable_nojekyll:
description: 'An alias for enable_jekyll to disable adding .nojekyll file to master or gh-pages branches'
required: false
default: 'false'
cname:
description: 'Set custom domain'
required: false
exclude_assets:
description: 'Set files or directories to exclude from a publish directory.'
required: false
default: '.github'