ghaction-github-pages

Go to file

Robin Röper 41f6a45ee8 GITHUB_TOKEN documentation link (#90 )		2020-04-26 19:44:14 +02:00
.github	Fix lint workflow	2020-04-18 07:30:45 +02:00
dist	Update generated content	2020-04-08 22:59:36 +00:00
lib	Check no changes (#62 )	2020-02-11 13:38:54 +01:00
src	Check no changes (#62 )	2020-02-11 13:38:54 +01: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	Use ncc	2020-04-09 00:59:11 +02:00
LICENSE	Test Dependabot Beta (v2)	2020-03-24 11:33:41 +01:00
package-lock.json	Bump @types/node from 13.13.1 to 13.13.2 (#89 )	2020-04-22 18:15:42 +02:00
package.json	Bump @types/node from 13.13.1 to 13.13.2 (#89 )	2020-04-22 18:15:42 +02:00
README.md	GITHUB_TOKEN documentation link (#90 )	2020-04-26 19:44:14 +02:00
tsconfig.json	Switch to TypeScript Action (#3 )	2019-10-11 01:41:16 +02:00

README.md

About

A GitHub Action to deploy to GitHub Pages

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

Usage

Below is a simple snippet to deploy to GitHub Pages. A test example is also available for this repository.

name: website

on: push

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      -
        name: Checkout
        uses: actions/checkout@v1
      -
        name: Build
        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
        if: success()
        uses: crazy-max/ghaction-github-pages@v1
        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_name`	String	Commit author's name (default GITHUB_ACTOR or `github-actions`)
`committer_email`	String	Commit author's email (default `<committer_name>@users.noreply.github.com`)
`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`
`GITHUB_PAT`	Personal Access Token (see Limitation section below)

Limitation

Currently, GITHUB_TOKEN does not suffice to trigger a page build on a public repository (propagate content to the GitHub content-delivery network). You must therefore create a custom Personal Access Token with repo permissions and use it through the GITHUB_PAT environment variable:

- name: Deploy
  if: success()
  uses: crazy-max/ghaction-github-pages@v1
  with:
    target_branch: gh-pages
    build_dir: public
  env:
    GITHUB_PAT: ${{ secrets.GITHUB_PAT }}

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.