2019-09-01 06:30:48 +08:00
[](https://github.com/crazy-max/ghaction-github-pages/releases/latest)
[](https://github.com/marketplace/actions/github-pages)
[](https://github.com/crazy-max/ghaction-github-pages/actions)
2019-11-15 02:25:19 +08:00
[](https://github.com/sponsors/crazy-max)
2019-09-01 04:23:41 +08:00
[](https://www.paypal.me/crazyws)
## ✨ About
2019-10-11 08:25:58 +08:00
A GitHub Action to deploy to GitHub Pages
2019-09-01 04:23:41 +08:00
2019-10-25 05:26:25 +08:00
If you are interested, [check out ](https://git.io/Je09Y ) my other :octocat: GitHub Actions!
2019-09-01 04:23:41 +08:00
## 🚀 Usage
2019-11-06 10:14:13 +08:00
Below is a simple snippet to deploy to GitHub Pages. A [test example ](https://github.com/crazy-max/ghaction-github-pages/actions?query=workflow%3Atest ) is also available for this repository.
2019-09-01 04:23:41 +08:00
```yaml
name: website
on: push
jobs:
publish:
runs-on: ubuntu-latest
steps:
-
name: Checkout
2019-10-11 07:51:17 +08:00
uses: actions/checkout@v1
2019-09-01 04:23:41 +08:00
-
name: Build
run: |
mkdir public
cat > public/index.html < < EOL
<!doctype html>
< html >
< head >
< title > GitHub Pages deployed!< / title >
< / head >
< body >
2019-09-01 06:30:48 +08:00
< 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 >
2019-09-01 04:23:41 +08:00
< / body >
< / html >
EOL
-
name: Deploy
2019-09-01 05:28:00 +08:00
if: success()
2019-10-11 07:51:17 +08:00
uses: crazy-max/ghaction-github-pages@v1
2019-09-01 04:23:41 +08:00
with:
2019-09-01 05:28:00 +08:00
target_branch: gh-pages
2019-09-01 04:23:41 +08:00
build_dir: public
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
## 💅 Customizing
### inputs
2019-09-01 05:28:00 +08:00
Following inputs can be used as `step.with` keys
2019-09-01 04:23:41 +08:00
2019-11-15 21:40:43 +08:00
| 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` ) |
2019-11-15 23:46:40 +08:00
| `allow_empty_commit` | Bool | Allow an empty commit to be created (default `true` ) |
2019-11-15 21:40:43 +08:00
| `build_dir` | String | Build directory to deploy (**required**) |
2019-11-16 22:04:57 +08:00
| `committer_name` | String | Commit author's name (default [GITHUB_ACTOR ](https://help.github.com/en/github/automating-your-workflow-with-github-actions/using-environment-variables#default-environment-variables ) or `github-actions` ) |
| `committer_email` | String | Commit author's email (default `<committer_name>@users.noreply.github.com` ) |
2019-11-15 21:40:43 +08:00
| `commit_message` | String | Commit message (default `Deploy to GitHub pages` ) |
| `fqdn` | String | Write the given domain name to the CNAME file |
2019-09-01 04:23:41 +08:00
### environment variables
2019-09-01 13:01:38 +08:00
Following environment variables can be used as `step.env` keys
2019-09-01 04:23:41 +08:00
2019-11-15 21:40:43 +08:00
| Name | Description |
|----------------|---------------------------------------|
| `GITHUB_TOKEN` | GITHUB_TOKEN as provided by `secrets` |
| `GITHUB_PAT` | [Personal Access Token ](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/ ) (see [Limitation section ](#warning-limitation ) below)|
2019-09-01 13:01:38 +08:00
## :warning: Limitation
2019-11-11 13:57:13 +08:00
Currently, `GITHUB_TOKEN` [does not suffice to trigger a page build ](https://github.community/t5/GitHub-Actions/Github-action-not-triggering-gh-pages-upon-push/m-p/26869 ) on a **public repository** (propagate content to the GitHub content-delivery network). You must therefore create a custom [Personal Access Token ](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/ ) and use it through the `GITHUB_PAT` environment variable:
2019-09-01 13:01:38 +08:00
```yaml
- name: Deploy
if: success()
2019-10-11 07:51:17 +08:00
uses: crazy-max/ghaction-github-pages@v1
2019-09-01 13:01:38 +08:00
with:
target_branch: gh-pages
build_dir: public
env:
GITHUB_PAT: ${{ secrets.GITHUB_PAT }}
```
2019-09-01 04:23:41 +08:00
## 🤝 How can I help ?
2019-11-15 02:25:19 +08:00
All kinds of contributions are welcome :raised_hands:! The most basic way to show your support is to star :star2: the project, or to raise issues :speech_balloon: You can also support this project by [**becoming a sponsor on GitHub** ](https://github.com/sponsors/crazy-max ) :clap: or by making a [Paypal donation ](https://www.paypal.me/crazyws ) to ensure this journey continues indefinitely! :rocket:
2019-09-01 04:23:41 +08:00
2019-11-15 02:25:19 +08:00
Thanks again for your support, it is much appreciated! :pray:
2019-09-01 04:23:41 +08:00
## 📝 License
MIT. See `LICENSE` for more details.
