Need help with ghaction-github-pages?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

crazy-max
146 Stars 16 Forks MIT License 271 Commits 3 Opened issues

Description

:octocat: GitHub Action to deploy to GitHub Pages

Services available

!
?

Need anything else?

Contributors list

# 10,025
Go
golang
github-...
telemet...
166 commits
# 232,050
TypeScr...
restful...
stress-...
Shell
1 commit
# 331,675
HTML
Shell
TypeScr...
github-...
1 commit
# 141,746
hangfir...
C#
.NET
schedul...
1 commit
# 126,031
Rust
pdf-doc...
solariz...
intelli...
1 commit
# 320,184
dynamod...
SQL
Kuberne...
TypeScr...
1 commit

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/[email protected] - name: Gen dummy page run: | mkdir public cat > public/index.html <

          <title>GitHub Pages deployed!</title>


          <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>


      EOL
  -
    name: Deploy to GitHub Pages
    if: success()
    uses: crazy-max/[email protected]
    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/[email protected]
        with:
          gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }}
          passphrase: ${{ secrets.PASSPHRASE }}
          git-user-signingkey: true
          git-commit-gpgsign: true
      -
        name: Deploy to GitHub Pages
        if: success()
        uses: crazy-max/[email protected]
        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/[email protected]
        with:
          pages_threshold: major_outage
      -
        name: Deploy to GitHub Pages
        if: success()
        uses: crazy-max/[email protected]
        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 
(defaults to the GitHub Actions bot user) | |
author
| String | Author name and email address as
Display Name 
(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 | |
jekyll
| Bool | Allow Jekyll to build your site (default
true
) |

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 |

Keep up-to-date with GitHub Dependabot

Since Dependabot has native GitHub Actions support, to enable it on your GitHub repo all you need to do is add the

.github/dependabot.yml
file:
version: 2
updates:
  # Maintain dependencies for GitHub Actions
  - package-ecosystem: "github-actions"
    directory: "/"
    schedule:
      interval: "daily"

How can I help?

All kinds of contributions are welcome :raisedhands:! The most basic way to show your support is to star :star2: the project, or to raise issues :speechballoon: You can also support this project by becoming a sponsor on GitHub :clap: or by making a Paypal donation to ensure this journey continues indefinitely! :rocket:

Thanks again for your support, it is much appreciated! :pray:

License

MIT. See

LICENSE
for more details.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.