ghaction-github-pages

Go to file

CrazyMax 4f1eca5fa5 Add CONTRIBUTING.md		2019-10-23 14:22:04 +02:00
.dependabot	Update dependabot conf	2019-10-23 11:30:04 +02:00
.github	Add CONTRIBUTING.md	2019-10-23 14:22:04 +02:00
.res	Update README	2019-09-01 07:33:20 +02:00
lib	Typo	2019-10-11 01:47:41 +02:00
node_modules/@actions	Update node_modules	2019-10-21 08:44:30 +00:00
src	Typo	2019-10-11 01:47:41 +02:00
.editorconfig	Add editorconfig	2019-09-15 06:59:39 +02:00
.gitattributes	Switch to TypeScript Action (#3 )	2019-10-11 01:41:16 +02:00
.gitignore	Add node_modules for testing purpose	2019-10-11 01:44:23 +02:00
.prettierrc.json	Switch to TypeScript Action (#3 )	2019-10-11 01:41:16 +02:00
action.yml	Spelling	2019-10-11 02:25:58 +02:00
LICENSE	Initial version	2019-08-31 22:23:41 +02:00
package-lock.json	Merge pull request #12 from crazy-max/dependabot/npm_and_yarn/commander-2.20.3	2019-10-23 08:16:51 +00:00
package.json	Bump @types/node from 12.11.2 to 12.11.5	2019-10-23 08:15:19 +00:00
README.md	Spelling	2019-10-11 02:25:58 +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

⚠️ 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 snippet 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@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`)
`build_dir`	String	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@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 💬
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.