Skip to content

Warning

You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?

Blazing fast GitHub Pages deploys

Actions
🔥 The most blazingest action to deploy your GitHub pages website
v0.0.1
Star (34)

Blazing fast GitHub Pages deploy

🔥 The most blazingest action to deploy your GitHub pages website

Why did you make another action to deploy to GitHub pages?

This GitHub action uses JavaScript for maximum speed 🚀.

Using a JavaScript action simplifies the action code and executes faster than a Docker container action.

Usage

  1. Create a new workflow by adding .github/workflows/deploy.yml to your project.
  2. Create a personal access token
  3. Create a secret containing the personal access token, call it GH_PAT
  4. 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 }}
          commit-name: 'Alex Page'
          commit-email: '[email protected]'

Workflow options

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 Values Required
repo-token The personal access token ${{ secrets.GH_PAT }} true
site-directory The site directory _site true
commit-name The name of the user doing the deploy commit Alex Page true
commit-email The email of the user doing the deploy commit [email protected] true
commit-message The commit message for the branch Deployed using Blazing fast GitHub Pages deploy action false

Release History

  • v0.0.1 - TypesScript, use callback instead of async
  • v0.0.0 - Initial release

Blazing fast GitHub Pages deploys is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

🔥 The most blazingest action to deploy your GitHub pages website
v0.0.1

Blazing fast GitHub Pages deploys is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.