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)
2020-05-09 21:17:14 +08:00
[](https://github.com/crazy-max/ghaction-github-pages/actions?workflow=ci)
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)
2020-01-23 22:11:55 +08:00
## About
2019-09-01 04:23:41 +08:00
2019-10-11 08:25:58 +08:00
A GitHub Action to deploy to GitHub Pages
2019-09-01 04:23:41 +08:00
2022-05-27 05:58:55 +08:00
If you are interested, [check out ](https://github.com/crazy-max?tab=repositories&q=ghaction&type=source&language=&sort= ) my other :octocat: GitHub Actions!
2019-10-25 05:26:25 +08:00
2020-05-07 23:39:05 +08:00
2020-05-11 20:59:39 +08:00
___
* [Usage ](#usage )
* [Workflow ](#workflow )
* [Sign commits ](#sign-commits )
2020-05-24 05:15:35 +08:00
* [Check availability of GitHub Pages ](#check-availability-of-github-pages )
2020-05-11 20:59:39 +08:00
* [Customizing ](#customizing )
* [inputs ](#inputs )
* [environment variables ](#environment-variables )
2021-08-01 11:12:08 +08:00
* [Contributing ](#contributing )
2020-05-11 20:59:39 +08:00
* [License ](#license )
2020-01-23 22:11:55 +08:00
## Usage
2019-09-01 04:23:41 +08:00
2020-05-11 20:59:39 +08:00
### Workflow
2020-05-09 21:11:59 +08:00
Below is a simple snippet to deploy to GitHub Pages with a dummy HTML page.
2021-03-16 07:04:53 +08:00
A [workflow ](https://github.com/crazy-max/ghaction-github-pages/actions?query=workflow%3Aci ) is also available for
this repository and deploys [everyday to GitHub pages ](https://crazy-max.github.io/ghaction-github-pages/ ).
2019-09-01 04:23:41 +08:00
```yaml
name: website
on: push
jobs:
publish:
runs-on: ubuntu-latest
steps:
-
name: Checkout
2022-05-27 05:47:21 +08:00
uses: actions/checkout@v3
2019-09-01 04:23:41 +08:00
-
2020-05-09 21:11:59 +08:00
name: Gen dummy page
2019-09-01 04:23:41 +08:00
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
-
2020-05-07 02:54:24 +08:00
name: Deploy to GitHub Pages
2019-09-01 05:28:00 +08:00
if: success()
2022-05-27 05:28:32 +08:00
uses: crazy-max/ghaction-github-pages@v3
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 }}
```
2020-05-11 20:59:39 +08:00
### Sign commits
2021-03-16 07:04:53 +08:00
You can use the [Import GPG ](https://github.com/crazy-max/ghaction-import-gpg ) GitHub Action along with this one to
sign commits:
2020-05-11 20:59:39 +08:00
```yaml
-
name: Import GPG key
2022-05-27 05:28:32 +08:00
uses: crazy-max/ghaction-import-gpg@v5
2020-05-11 20:59:39 +08:00
with:
2022-05-27 05:28:32 +08:00
gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
2020-09-07 04:15:12 +08:00
passphrase: ${{ secrets.PASSPHRASE }}
2022-05-27 05:28:32 +08:00
git_user_signingkey: true
git_commit_gpgsign: true
2020-05-11 20:59:39 +08:00
-
name: Deploy to GitHub Pages
if: success()
2022-05-27 05:28:32 +08:00
uses: crazy-max/ghaction-github-pages@v3
2020-05-11 20:59:39 +08:00
with:
target_branch: gh-pages
build_dir: public
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
2020-05-24 05:15:35 +08:00
### Check availability of GitHub Pages
2021-03-16 07:04:53 +08:00
You can use the [GitHub Status ](https://github.com/crazy-max/ghaction-github-status ) Action along with this one to
check availability of GitHub Pages before deploying:
2020-05-24 05:15:35 +08:00
```yaml
-
name: Check GitHub Pages status
2022-05-27 05:28:32 +08:00
uses: crazy-max/ghaction-github-status@v3
2020-05-24 05:15:35 +08:00
with:
pages_threshold: major_outage
-
name: Deploy to GitHub Pages
if: success()
2022-05-27 05:28:32 +08:00
uses: crazy-max/ghaction-github-pages@v3
2020-05-24 05:15:35 +08:00
with:
target_branch: gh-pages
build_dir: public
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
2020-01-23 22:11:55 +08:00
## Customizing
2019-09-01 04:23:41 +08:00
### 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
2021-03-16 07:04:53 +08:00
| Name | Type | Description |
|----------------------|---------|--------------------------------------------------------------------------------|
| `domain` | String | Git domain (default `github.com` ) |
| `repo` | String | GitHub repository where assets will be deployed (default `$GITHUB_REPOSITORY` ) |
| `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**) |
2022-01-13 17:51:54 +08:00
| `absolute_build_dir` | Bool | Whether to treat `build_dir` as an absolute path (defaults to `false` , making it relative to the working directory) |
| `follow_symlinks` | Bool | If enabled, the content of symbolic links will be copied (default `false` ) |
2020-05-11 20:59:39 +08:00
| `committer` | String | Committer name and email address as `Display Name <joe@foo.bar>` (defaults to the GitHub Actions bot user) |
| `author` | String | Author name and email address as `Display Name <joe@foo.bar>` (defaults to the GitHub Actions bot user) |
2021-03-16 07:04:53 +08:00
| `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` ) |
2021-05-30 11:00:48 +08:00
| `dry_run` | Bool | If enabled, nothing will be pushed (default `false` ) |
| `verbose` | Bool | Enable verbose output (default `false` ) |
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 |
|----------------|---------------------------------------|
2020-04-27 01:44:14 +08:00
| `GITHUB_TOKEN` | [GITHUB_TOKEN ](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token ) as provided by `secrets` |
2020-05-11 20:59:39 +08:00
| `GH_PAT` | Use a [Personal Access Token ](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/ ) if you want to deploy to another repo |
2019-09-01 13:01:38 +08:00
2021-08-01 11:12:08 +08:00
## Contributing
2020-08-20 23:32:26 +08:00
2021-08-01 11:12:08 +08:00
Want to contribute? Awesome! The most basic way to show your support is to star the project, or to raise issues. If
you want to open a pull request, please read the [contributing guidelines ](.github/CONTRIBUTING.md ).
2020-08-20 23:32:26 +08:00
2021-08-01 11:12:08 +08:00
You can also support this project by [**becoming a sponsor on GitHub** ](https://github.com/sponsors/crazy-max ) or by
making a [Paypal donation ](https://www.paypal.me/crazyws ) to ensure this journey continues indefinitely!
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
2020-01-23 22:11:55 +08:00
## License
2019-09-01 04:23:41 +08:00
MIT. See `LICENSE` for more details.
