lmaotrigine/Deploy GitHub Pages Action
GitHub action to deploy assets to GitHub Pages.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| deploy_key | A SSH ed25519 private key from a repository secret value for pushing to the remote branch. | no | — |
| github_token | A generated GITHUB_TOKEN for pushing to the remote branch. | no | — |
| personal_access_token | A Personal Access Token (PAT) for pushing to the remote branch. | no | — |
| publish_branch | Target branch for deployment. | no | gh-pages |
| publish_dir | Source directory to deploy. | no | public |
| dest_dir | Destination subdirectory of deployment. | no | "" |
| external_repository | Set an external repository (owner/repo) to deploy to. | no | — |
| allow_empty_commit | Specify whether empty commits are allowed to the target branch. | no | false |
| keep_files | Specify whether existing files in the target branch should be removed before deployment. | no | false |
| force_orphan | Keep only the latest commit on the target branch. | no | false |
| user_name | Git user.name | no | — |
| user_email | Git user.email | no | — |
| commit_message | Custom commit message to prepend to the triggered commit SHA. | no | — |
| full_commit_message | Custom commit message that overwrites the default completely. | no | — |
| tag_name | Specify an optional tag name for the deployment | no | — |
| tag_message | Specify the message for the tag | no | — |
| enable_jekyll | Enable the GitHub pages built-in Jekyll | no | false |
| disable_nojekyll | Alias for enable_jekyll. | no | false |
| cname | Set a custom domain | no | — |
| exclude_assets | Files or directories to exclude from being published | no | .github |
Outputs
no outputs