You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
Blazing fast GitHub Pages deploys
v1.0.2
🔥 The most blazingest action to deploy your GitHub pages website
This GitHub action uses JavaScript for maximum speed 🚀.
Using a JavaScript action simplifies the action code and executes faster than a Docker container action.
- Create a new workflow by adding
.github/workflows/deploy.yml
to your project. - Create a personal access token
- Create a secret containing the personal access token, call it
GH_PAT
- Modify the workflow options for your project
Here is an example deploy.yml
file:
name: Blazing fast GitHub Pages deploy
on:
push:
branches:
- master
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: npm install, test and build
run: |
npm install
npm run test
npm run build
- name: Deploy site to gh-pages branch
uses: alex-page/[email protected]
with:
repo-token: ${{ secrets.GH_PAT }}
If you want a more custom experience you can add these values. For more detailed explanation of the workflow file, check out the GitHub documentation.
Setting | Description | Default value | Required |
---|---|---|---|
repo-token |
The personal access token | ${{ secrets.GH_PAT }} |
true |
site-directory |
The site directory | _site |
true |
commit-message |
The commit message for the branch | Deployed using Blazing fast GitHub Pages deploy action | true |
deploy-branch |
The branch to deploy the built website to | gh-pages |
true |
- v1.0.2 - Use head_commit for when there is no push
- v1.0.1 - Return on error
- v1.0.0 - Remove required name and email. Fix breaking bug with incorrect repository URL.
- v0.0.1 - TypesScript, use callback instead of async
- v0.0.0 - Initial release