edricchan03/Build and deploy to GitHub Pages
Builds and deploys a Jekyll site to GitHub Pages
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github_token | The GitHub installation token. | yes | — |
| gh_pages_token | The token used for triggering a deploy request. (This is no longer needed - see https://github.community/t5/GitHub-Actions/Github-action-not-triggering-gh-pages-upon-push/m-p/46519/highlight/true#M6551) | no | — |
| gh_pages_branch | The branch to deploy the Jekyll site to. | no | gh-pages |
| gh_pages_dist_folder | The folder to build the Jekyll site to. | no | _site |
| gh_pages_commit_message | The commit message to use when deploying the Jekyll site. | no | — |
| remote_repo | The repository to deploy the Jekyll site to. | no | — |
| jekyll_build_opts | Options to pass to the Jekyll build command. | no | — |
| committer_username | The username to use for the committer of the commit. | no | — |
| committer_email | The email to use for the committer of the commit. | no | — |
| git_force | Whether to use the --force flag on git push. | no | true |
| override_gh_pages_branch | Whether to override the gh-pages branch. | no | false |
| gh_pages_add_no_jekyll | Whether to add the .nojekyll file to the deployed site. | no | true |
| skip_deploy | Whether to skip deployment after a successful build. | no | false |
| show_bundle_log | Whether to show detailed logs from the bundle install command. | no | false |
| bundler_version | A specific version of Bundler to be used. | no | — |
| jekyll_env | The Jekyll environment to use when building the site. (See https://jekyllrb.com/docs/configuration/environments/) | no | production |
Outputs
no outputs