ghaction-github-pages

Go to file

CrazyMax 2f1196a43b Use inputs as env		2019-09-03 04:38:29 +02:00
.github/workflows	Update docker workflow	2019-09-02 17:55:54 +02:00
.res	Update README	2019-09-01 07:33:20 +02:00
.dockerignore	Initial version	2019-08-31 22:23:41 +02:00
.gitignore	Fix refs	2019-09-01 00:57:52 +02:00
action.yml	Change icon	2019-08-31 23:48:53 +02:00
Dockerfile	Push Docker image to DockerHub	2019-09-02 17:51:26 +02:00
entrypoint.sh	Use inputs as env	2019-09-03 04:38:29 +02:00
LICENSE	Initial version	2019-08-31 22:23:41 +02:00
README.md	Use inputs as env	2019-09-03 04:38:29 +02:00

README.md

✨ About

A GitHub Action for deploying GitHub Pages

⚠️ Note: To use this action, you must have access to the GitHub Actions feature. GitHub Actions are currently only available in public beta. You can apply for the GitHub Actions beta here.

🚀 Usage

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

name: website

on: push

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      -
        name: Checkout
        uses: actions/checkout@master
      -
        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@master
        with:
          target_branch: gh-pages
          build_dir: public
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Docker 🐳 image is also provided and automatically updated within Docker Hub so you can directly use the following Docker Hub action:

- name: Deploy
  if: success()
  uses: docker://crazymax/ghaction-github-pages
  env:
    INPUT_TARGET_BRANCH: gh-pages
    INPUT_BUILD_DIR: public
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

💅 Customizing

inputs

Following inputs can be used as step.with keys

Name	Type	Description
`target_branch`	String	Git branch where assets will be deployed (default `gh-pages`)
`build_dir`	String	Path to build directory to deploy

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 and use it through the GITHUB_PAT environment variable:

- name: Deploy
  if: success()
  uses: crazy-max/ghaction-github-pages@master
  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 💬
But we're not gonna lie to each other, I'd rather you buy me a beer or two 🍻!

📝 License

MIT. See LICENSE for more details.