Go to file
2020-05-24 01:23:37 +02:00
.github Update workflows 2020-05-24 01:13:31 +02:00
dist Update generated content 2020-05-24 00:22:57 +02:00
src Update workflows 2020-05-11 15:10:53 +02:00
.editorconfig Update editorconfig 2020-04-09 03:37:51 +02:00
.gitattributes Use ncc 2020-04-09 00:59:11 +02:00
.gitignore Use ncc 2020-04-09 00:59:11 +02:00
.prettierrc.json Match vars and inputs 2019-11-06 03:02:59 +01:00
action.yml Add ability to sign commits through Import GPG GitHub Action 2020-05-11 14:59:39 +02:00
CHANGELOG.md Update CHANGELOG 2020-05-24 01:23:37 +02:00
LICENSE Test Dependabot Beta (v2) 2020-03-24 11:33:41 +01:00
package-lock.json Bump @types/node from 14.0.4 to 14.0.5 (#102) 2020-05-22 04:01:10 +00:00
package.json Bump @types/node from 14.0.4 to 14.0.5 (#102) 2020-05-22 04:01:10 +00:00
README.md Update README 2020-05-24 01:22:00 +02:00
tsconfig.json Add ability to sign commits through Import GPG GitHub Action 2020-05-11 14:59:39 +02:00

GitHub release GitHub marketplace CI workflow Become a sponsor Paypal Donate

About

A GitHub Action to deploy to GitHub Pages

If you are interested, check out my other :octocat: GitHub Actions!

GitHub Pages


Usage

Workflow

Below is a simple snippet to deploy to GitHub Pages with a dummy HTML page.

A workflow is also available for this repository and deploys everyday to GitHub pages.

name: website

on: push

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      -
        name: Checkout
        uses: actions/checkout@v2
      -
        name: Gen dummy page
        run: |
          mkdir public
          cat > public/index.html <<EOL
          <!doctype html>
          <html>
            <head>
              <title>GitHub Pages deployed!</title>
            </head>
            <body>
              <p>GitHub Pages with <strong>${{ github.sha }}</strong> commit ID has been deployed through <a href="https://github.com/marketplace/actions/github-pages">GitHub Pages action</a> successfully.</p>
            </body>
          </html>
          EOL          
      -
        name: Deploy to GitHub Pages
        if: success()
        uses: crazy-max/ghaction-github-pages@v2
        with:
          target_branch: gh-pages
          build_dir: public
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Sign commits

You can use the Import GPG GitHub Action along with this one to sign commits:

      -
        name: Import GPG key
        uses: crazy-max/ghaction-import-gpg@v2
        with:
          git_user_signingkey: true
          git_commit_gpgsign: true
        env:
          GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }}
          PASSPHRASE: ${{ secrets.PASSPHRASE }}
      -
        name: Deploy to GitHub Pages
        if: success()
        uses: crazy-max/ghaction-github-pages@v2
        with:
          target_branch: gh-pages
          build_dir: public
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Check availability of GitHub Pages

You can use the GitHub Status Action along with this one to check availability of GitHub Pages before deploying:

      -
        name: Check GitHub Pages status
        uses: crazy-max/ghaction-github-status@v1
        with:
          pages_threshold: major_outage
      -
        name: Deploy to GitHub Pages
        if: success()
        uses: crazy-max/ghaction-github-pages@v2
        with:
          target_branch: gh-pages
          build_dir: public
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Customizing

inputs

Following inputs can be used as step.with keys

Name Type Description
repo String GitHub repository where assets will be deployed (default current)
target_branch String Git branch where assets will be deployed (default gh-pages)
keep_history Bool Create incremental commit instead of doing push force (default false)
allow_empty_commit Bool Allow an empty commit to be created (default true)
build_dir String Build directory to deploy (required)
committer String Committer name and email address as Display Name <joe@foo.bar> (defaults to the GitHub Actions bot user)
author String Author name and email address as Display Name <joe@foo.bar> (defaults to the GitHub Actions bot user)
commit_message String Commit message (default Deploy to GitHub pages)
fqdn String Write the given domain name to the CNAME file

environment variables

Following environment variables can be used as step.env keys

Name Description
GITHUB_TOKEN GITHUB_TOKEN as provided by secrets
GH_PAT Use a Personal Access Token if you want to deploy to another repo

How can I help?

All kinds of contributions are welcome 🙌! The most basic way to show your support is to star 🌟 the project, or to raise issues 💬 You can also support this project by becoming a sponsor on GitHub 👏 or by making a Paypal donation to ensure this journey continues indefinitely! 🚀

Thanks again for your support, it is much appreciated! 🙏

License

MIT. See LICENSE for more details.