step-security/GitHub Pages action
GitHub Actions for GitHub Pages 🚀 Deploy static files and publish your site easily. Static-Site-Generators-friendly.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| deploy_key | Set a SSH private key from repository secret value for pushing to the remote branch. | no | — |
| github_token | Set a generated GITHUB_TOKEN for pushing to the remote branch. | no | — |
| personal_token | Set a personal access token for pushing to the remote branch. | no | — |
| publish_branch | Set a target branch for deployment. | no | gh-pages |
| publish_dir | Set an input directory for deployment. | no | public |
| destination_dir | Set an destination subdirectory for deployment. | no | "" |
| external_repository | Set an external repository (owner/repo). | no | — |
| allow_empty_commit | If empty commits should be made to the publication branch | no | false |
| keep_files | If existing files in the publish branch should be not removed before deploying | no | false |
| force_orphan | Keep only the latest commit on a GitHub Pages branch | no | false |
| user_name | Set Git user.name | no | — |
| user_email | Set Git user.email | no | — |
| commit_message | Set a custom commit message with a triggered commit hash | no | — |
| full_commit_message | Set a custom full commit message without a triggered commit hash | no | — |
| tag_name | Set tag name | no | — |
| tag_message | Set tag message | no | — |
| enable_jekyll | Enable the GitHub Pages built-in Jekyll | no | false |
| disable_nojekyll | An alias for enable_jekyll to disable adding .nojekyll file to a publishing branch | no | false |
| cname | Set custom domain | no | — |
| exclude_assets | Set files or directories to exclude from a publish directory. | no | .github |
Outputs
no outputs