README.md

GitHub Pages deploy

This Action deploys a static site on GitHub Pages.

Usage

See action.yml.

- name: Deploy to GitHub Pages
  uses: Cecilapp/GitHub-Pages-deploy@v3
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  with:
    email: username@domain.tld      # required
    build_dir: _site                # "_site" by default
    branch: website                 # "gh-pages" by default
    cname: domain.tld               # empty by default
    jekyll: no                      # "no" by default
    commit_message: custom message  # optional

Workflow example

name: GitHub Pages deploy
on:
  push:
    branches:
      - master
jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Build
        uses: # build your static site

      - name: Deploy to GitHub Pages
        uses: Cecilapp/GitHub-Pages-deploy@v3
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          email: username@domain.tld
          build_dir: _site

About user and organization sites

The default publishing source for user and organization sites is the root of the default branch for the repository.

See documentation.

v2 VS v3

GitHub Pages deploy v3 use the secrets.GITHUB_TOKEN instead of a personal access token (PAT), and inputs parameters instead of environment variables. If you want to continue using the previous release (with environment variables) you must set the version: Cecilapp/GitHub-Pages-deploy@v2.

License

GitHub Pages deploy is a free software distributed under the terms of the MIT license.

© Arnaud Ligny