sivamani-18/GitHub Pages Action

GitHub Actions for deploying static files to GitHub Pages. This action supports various static site generators and allows seamless publishing of your site with enhanced configuration options.

View on GitHub

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Stale
License: None

Inputs

name	description	required	default
token	Token for pushing to the remote branch.	no	—
deploy_key	SSH private key from repository secret for pushing to the remote branch.	no	—
github_token	Generated GITHUB_TOKEN for pushing to the remote branch.	no	—
personal_token	Personal access token for pushing to the remote branch.	no	—
publish_branch	Target branch for deployment.	no	gh-pages
publish_dir	Input directory for deployment.	no	public
destination_dir	Destination subdirectory for deployment.	no	""
external_repository	External repository in the format owner/repo.	no	—
allow_empty_commit	Whether to allow empty commits to the publication branch.	no	false
keep_files	Whether to retain existing files in the publish branch before deploying.	no	false
force_orphan	Create a new branch keeping only the latest commit for GitHub Pages.	no	false
user_name	Git user.name for commits.	no	—
user_email	Git user.email for commits.	no	—
commit_message	Custom commit message with a triggered commit hash.	no	—
full_commit_message	Custom full commit message without a triggered commit hash.	no	—
tag_name	Tag name for the deployment.	no	—
tag_message	Tag message for the deployment.	no	—
enable_jekyll	Enable GitHub Pages built-in Jekyll.	no	false
disable_nojekyll	Disable adding .nojekyll file to the publishing branch (alias for enable_jekyll).	no	false
cname	Custom domain for the GitHub Pages site.	no	—
exclude_assets	Files or directories to exclude from the publish directory.	no	.github

Outputs

no outputs