actions-marketplace-validations/GitHub Pages Publisher

Deploys already generated static pages to GitHub Pages.

Trust Signals

name	description	required	default
cname	If set, create a `CNAME` file with the provided value.	no	—
defaultBranch	The default branch name for the repository, defaults to `master` for backwards-compatiblity reasons. Version 2.x will likely default to `main`.	no	—
docsPath	The folder where the generated docs are located, defaults to `docs`.	no	—
gitCommitEmail	The email to use when committing to the repository, defaults to the repository owner's fake GitHub email.	no	""
gitCommitFlags	Any extra `git commit` flags to pass, such as `--no-verify`.	no	""
gitCommitMessage	The commit message to use when creating/updating the GitHub Pages branch.	no	Publish
gitCommitUser	The value to set `git config user.name`, defaults to the repository owner.	no	—
noCommit	If set, stage changes but do not commit them, defaults to `false`.	no	—
publishBranch	The branch name that GitHub Pages uses to build the website, defaults to `gh-pages`.	no	—
redirectURLSuffix	The path suffix for the redirect URL used in `index.html`, when `versionDocs` is `true`.	no	—
showUnderscoreFiles	If set, adds a `.nojekyll` file to the root so files that start with `_` are accessible.	no	—
versionDocs	If set, put docs for all branches and tags in their own subfolders, defaults to `false`.	no	—

no outputs