ghaction-github-pages/action.yml

# https://help.github.com/en/articles/metadata-syntax-for-github-actions
name: 'GitHub Pages'
description: 'GitHub Action to deploy to GitHub Pages'
author: 'crazy-max'
branding:
  color: 'green'
  icon: 'upload-cloud'

inputs:
  domain:
    description: 'Git domain (default github.com)'
    required: false
    default: 'github.com'
  repo:
    description: 'GitHub repository where assets will be deployed (default $GITHUB_REPOSITORY)'
    required: false
  target_branch:
    description: 'Git branch where assets will be deployed'
    default: 'gh-pages'
    required: false
  keep_history:
    description: 'Create incremental commit instead of doing push force'
    default: 'false'
    required: false
  allow_empty_commit:
    description: 'Allow an empty commit to be created'
    default: 'true'
    required: false
  build_dir:
    description: 'Build directory to deploy'
    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'
    required: false
  author:
    description: 'The author name and email address'
    required: false
  commit_message:
    description: 'Commit message'
    required: false
  fqdn:
    description: 'Write the given domain name to the CNAME file'
    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

runs:
  using: 'node20'
  main: 'dist/index.js'
Initial version 2019-09-01 04:23:41 +08:00			`# https://help.github.com/en/articles/metadata-syntax-for-github-actions`
			`name: 'GitHub Pages'`
Spelling 2019-10-11 08:25:58 +08:00			`description: 'GitHub Action to deploy to GitHub Pages'`
Initial version 2019-09-01 04:23:41 +08:00			`author: 'crazy-max'`
			`branding:`
			`color: 'green'`
Change icon 2019-09-01 05:48:53 +08:00			`icon: 'upload-cloud'`
Initial version 2019-09-01 04:23:41 +08:00
			`inputs:`
Switch to domain input for GIT_DOMAIN 2021-03-16 07:04:53 +08:00			`domain:`
			`description: 'Git domain (default github.com)'`
			`required: false`
			`default: 'github.com'`
Add repo input 2019-10-03 09:16:44 +08:00			`repo:`
Switch to domain input for GIT_DOMAIN 2021-03-16 07:04:53 +08:00			`description: 'GitHub repository where assets will be deployed (default $GITHUB_REPOSITORY)'`
Fix action yml 2020-05-09 21:17:14 +08:00			`required: false`
Add target_branch input 2019-09-01 05:28:00 +08:00			`target_branch:`
			`description: 'Git branch where assets will be deployed'`
			`default: 'gh-pages'`
Fix action yml 2020-05-09 21:17:14 +08:00			`required: false`
Add keep_history, allow_empty_commit and fqdn inputs (#23) Log latest changes 2019-11-15 21:40:43 +08:00			`keep_history:`
			`description: 'Create incremental commit instead of doing push force'`
			`default: 'false'`
Fix action yml 2020-05-09 21:17:14 +08:00			`required: false`
Add keep_history, allow_empty_commit and fqdn inputs (#23) Log latest changes 2019-11-15 21:40:43 +08:00			`allow_empty_commit:`
			`description: 'Allow an empty commit to be created'`
			`default: 'true'`
Fix action yml 2020-05-09 21:17:14 +08:00			`required: false`
Initial version 2019-09-01 04:23:41 +08:00			`build_dir:`
Switch to TypeScript Action (#3) 2019-10-11 07:41:16 +08:00			`description: 'Build directory to deploy'`
Initial version 2019-09-01 04:23:41 +08:00			`required: true`
Add input options related to `copy()` (#161) * Add absolute_build_dir input option This commit adds absolute_build_dir as an additional input. If the option is set, the provided build_dir argument won't be treated as a relative path to the current working directory anymore. This is helpful in environments like Nix, where the build is output to a static folder (for example /nix/store). Closes #159. * Add follow_symlinks option This option allows symbolic links in the source directory to be followed, recursively copying the entire directory structure. * Update outputs * Add missing inputs to action.yml * Add default values to input options This concerns absolute_build_dir and follow_symlinks. Co-authored-by: CrazyMax <github@crazymax.dev> Co-authored-by: CrazyMax <github@crazymax.dev> 2022-01-13 17:51:54 +08:00			`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`
Add ability to sign commits through Import GPG GitHub Action Add author input Fix default committer and author for GitHub Actions bot Replace GITHUB_PAT env var with GH_PAT (#53) Replace committer_name and committer_email inputs with committer 2020-05-11 20:59:39 +08:00			`committer:`
			`description: 'The committer name and email address'`
Fix action yml 2020-05-09 21:17:14 +08:00			`required: false`
Add ability to sign commits through Import GPG GitHub Action Add author input Fix default committer and author for GitHub Actions bot Replace GITHUB_PAT env var with GH_PAT (#53) Replace committer_name and committer_email inputs with committer 2020-05-11 20:59:39 +08:00			`author:`
			`description: 'The author name and email address'`
Fix action yml 2020-05-09 21:17:14 +08:00			`required: false`
Customization for commit message, committer name/email (#9) 2019-11-06 09:46:35 +08:00			`commit_message:`
Review some inputs 2019-11-06 10:10:09 +08:00			`description: 'Commit message'`
Fix action yml 2020-05-09 21:17:14 +08:00			`required: false`
Add keep_history, allow_empty_commit and fqdn inputs (#23) Log latest changes 2019-11-15 21:40:43 +08:00			`fqdn:`
			`description: 'Write the given domain name to the CNAME file'`
Fix action yml 2020-05-09 21:17:14 +08:00			`required: false`
Add jekyll input option (#116) GitHub Pages will use Jekyll to build your site by default. This input option allows for this functionality to be disabled. The option is left to `true` by default as setting to `false` will cause the `.nojekyll` file to be written to the output directory. https://help.github.com/en/github/working-with-github-pages/about-github-pages#static-site-generators 2020-06-25 15:24:31 +08:00			`jekyll:`
			`description: 'Allow Jekyll to build your site'`
			`default: 'true'`
			`required: false`
Add `verbose` input (#150) Co-authored-by: CrazyMax <crazy-max@users.noreply.github.com> 2021-05-30 11:00:48 +08:00			`dry_run:`
Add dry-run input (#144) Co-authored-by: CrazyMax <crazy-max@users.noreply.github.com> 2021-05-13 08:23:35 +08:00			`description: 'If enabled, nothing will be pushed'`
			`default: 'false'`
			`required: false`
Add `verbose` input (#150) Co-authored-by: CrazyMax <crazy-max@users.noreply.github.com> 2021-05-30 11:00:48 +08:00			`verbose:`
			`description: 'Enable verbose output'`
			`default: 'false'`
			`required: false`
Initial version 2019-09-01 04:23:41 +08:00
			`runs:`
chore: node 20 as default runtime 2023-09-10 02:26:32 +08:00			`using: 'node20'`
Use ncc 2020-04-09 06:59:11 +08:00			`main: 'dist/index.js'`