Deploy to GitHub Pages

A GitHub Action that builds and deploys a Jekyll site to GitHub Pages.

This GitHub Action requires a GitHub personal access token to deploy commits. To create one, click here and specify the GH_PAGES_TOKEN environment variable in your GitHub repository's Secrets.

Note: This branch (v2) contains work for the latest and most recent version of GitHub Actions, which was recently revamped to use YAML syntax. See the announcement post for more info.

Usage

See action.yml for a list of all supported inputs.

Secrets used

This script requires the following secrets:

Name	Description	Allowed values
`GITHUB_TOKEN`	Specifies the GitHub installation token.	A valid GitHub installation token. (Note: GitHub already creates one for you by default - you just need to manually specify this token in your workflow file.)
`GH_PAGES_TOKEN`	Specifies the personal access token to use to request a build request (required)	No default

Examples

Basic

steps:
  - uses: actions/checkout@master
  - uses: EdricChan03/action-build-deploy-ghpages@v2.2.1
    with:
      github_token: ${{ secrets.GITHUB_TOKEN }}
      gh_pages_token: ${{ secrets.GH_PAGES_TOKEN }}

Environment variables (`v1`)

v2 of this GitHub Action also supports the former environment variables in v1 of the action:

steps:
  - uses: actions/checkout@master
  - uses: EdricChan03/action-build-deploy-ghpages@v2.2.1
    env:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      GH_PAGES_TOKEN: ${{ secrets.GH_PAGES_TOKEN }}
      OVERRIDE_GH_PAGES_BRANCH: 'true'
      # ...

All inputs (with defaults)

Note: Not all of the inputs below have default values - consult the action file for more info.

steps:
  - uses: actions/checkout@master
  - uses: EdricChan03/action-build-deploy-ghpages@v2.2.1
    with:
      github_token: ${{ secrets.GITHUB_TOKEN }} # Note: You don't have to create this secret - GitHub already does that for you (This input does not have a default value - you have to supply this yourself)
      gh_pages_token: ${{ secrets.GH_PAGES_TOKEN }} # Note: You have to create this yourself - see the "Secrets used" section above for more info (This input does not have a default value - you have to supply this yourself)
      gh_pages_branch: 'gh-pages' # The GitHub Pages branch to deploy the site to
      gh_pages_dist_folder: '_site' # The folder to build the site to
      gh_pages_commit_message: 'Deploy commit $GITHUB_SHA\n\nAutodeployed using $GITHUB_ACTION in $GITHUB_WORKFLOW' # The commit message to use when deploying the site
      remote_repo: 'https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git' # The repository to deploy the site to
      committer_username: '$GITHUB_ACTOR' # The username to use for the committer of the commit
      committer_email: '${GITHUB_ACTOR}@users.noreply.github.com' # The email to use for the committer of the commit
      git_force: 'true' # Whether to use the --force flag when pushing the commit
      override_gh_pages_branch: 'false' # Whether to override the gh-pages branch on push
      gh_pages_add_no_jekyll: 'true' # Whether to add the .nojekyll file to the deployed site
      skip_deploy: 'false' # Whether to skip deployment after a successful build.

fabacab/action-build-deploy-ghpages