GitHub Pages deploy
This Action deploys a static site on GitHub Pages.
GitHub Pages deploy v3 now 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
.
Usage
See action.yml.
- name: Deploy to GitHub Pages
uses: Cecilapp/GitHub-Pages-deploy@v3
env:![badge](https://user-images.githubusercontent.com/80580/188000416-327192fc-4f0f-468f-b619-ad426c58b2a8.svg)
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
email: [email protected]
build_dir: _site # optional
branch: website # optional
cname: domain.tld # optional
jekyll: no # optional
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@v2
- 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: [email protected]
build_dir: _site
Note 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.
License
GitHub Pages deploy is a free software distributed under the terms of the MIT license.