actions/ghaction-github-pages
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
8aa8a51b62
ghaction-github-pages/README.md

156 lines
6.4 KiB
Markdown
Raw Normal View History

Add test workflow
2019-09-01 06:30:48 +08:00
[![GitHub release](https://img.shields.io/github/release/crazy-max/ghaction-github-pages.svg?style=flat-square)](https://github.com/crazy-max/ghaction-github-pages/releases/latest)
[![GitHub marketplace](https://img.shields.io/badge/marketplace-github--pages-blue?logo=github&style=flat-square)](https://github.com/marketplace/actions/github-pages)
Fix action yml
2020-05-09 21:17:14 +08:00
[![CI workflow](https://img.shields.io/github/workflow/status/crazy-max/ghaction-github-pages/ci?label=ci&logo=github&style=flat-square)](https://github.com/crazy-max/ghaction-github-pages/actions?workflow=ci)
Update README
2019-11-15 02:25:19 +08:00
[![Become a sponsor](https://img.shields.io/badge/sponsor-crazy--max-181717.svg?logo=github&style=flat-square)](https://github.com/sponsors/crazy-max)
Initial version
2019-09-01 04:23:41 +08:00
[![Paypal Donate](https://img.shields.io/badge/donate-paypal-00457c.svg?logo=paypal&style=flat-square)](https://www.paypal.me/crazyws)
Update README
2020-01-23 22:11:55 +08:00
## About
Initial version
2019-09-01 04:23:41 +08:00
Spelling
2019-10-11 08:25:58 +08:00
A GitHub Action to deploy to GitHub Pages
Initial version
2019-09-01 04:23:41 +08:00
Update README
2019-10-25 05:26:25 +08:00
If you are interested, [check out](https://git.io/Je09Y) my other :octocat: GitHub Actions!
Update README
2020-05-07 23:39:05 +08:00
![GitHub Pages](.github/ghaction-github-pages.png)
Add ability to sign commits through Import GPG GitHub Action Add author input Fix default committer and author for GitHub Actions bot Replace GITHUB_PAT env var with GH_PAT (#53) Replace committer_name and committer_email inputs with committer
2020-05-11 20:59:39 +08:00
___
* [Usage](#usage)
* [Workflow](#workflow)
* [Sign commits](#sign-commits)
Check availability of GitHub Pages example
2020-05-24 05:15:35 +08:00
* [Check availability of GitHub Pages](#check-availability-of-github-pages)
Add ability to sign commits through Import GPG GitHub Action Add author input Fix default committer and author for GitHub Actions bot Replace GITHUB_PAT env var with GH_PAT (#53) Replace committer_name and committer_email inputs with committer
2020-05-11 20:59:39 +08:00
* [Customizing](#customizing)
* [inputs](#inputs)
* [environment variables](#environment-variables)
* [How can I help?](#how-can-i-help)
* [License](#license)
Update README
2020-01-23 22:11:55 +08:00
## Usage
Initial version
2019-09-01 04:23:41 +08:00
Add ability to sign commits through Import GPG GitHub Action Add author input Fix default committer and author for GitHub Actions bot Replace GITHUB_PAT env var with GH_PAT (#53) Replace committer_name and committer_email inputs with committer
2020-05-11 20:59:39 +08:00
### Workflow
Update CI workflow
2020-05-09 21:11:59 +08:00
Below is a simple snippet to deploy to GitHub Pages with a dummy HTML page.
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/).
Initial version
2019-09-01 04:23:41 +08:00
```yaml
name: website
on: push
jobs:
publish:
runs-on: ubuntu-latest
steps:
-
name: Checkout
Update workflows
2020-05-07 02:54:24 +08:00
uses: actions/checkout@v2
Initial version
2019-09-01 04:23:41 +08:00
-
Update CI workflow
2020-05-09 21:11:59 +08:00
name: Gen dummy page
Initial version
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>
Add test workflow
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>
Initial version
2019-09-01 04:23:41 +08:00
</body>
</html>
EOL
-
Update workflows
2020-05-07 02:54:24 +08:00
name: Deploy to GitHub Pages
Add target_branch input
2019-09-01 05:28:00 +08:00
if: success()
Update workflows
2020-05-11 21:10:43 +08:00
uses: crazy-max/ghaction-github-pages@v2
Initial version
2019-09-01 04:23:41 +08:00
with:
Add target_branch input
2019-09-01 05:28:00 +08:00
target_branch: gh-pages
Initial version
2019-09-01 04:23:41 +08:00
build_dir: public
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
Add ability to sign commits through Import GPG GitHub Action Add author input Fix default committer and author for GitHub Actions bot Replace GITHUB_PAT env var with GH_PAT (#53) Replace committer_name and committer_email inputs with committer
2020-05-11 20:59:39 +08:00
### Sign commits
You can use the [Import GPG](https://github.com/crazy-max/ghaction-import-gpg) GitHub Action along with this one to sign commits:
```yaml
-
name: Import GPG key
Update README
2020-05-18 05:28:38 +08:00
uses: crazy-max/ghaction-import-gpg@v2
Add ability to sign commits through Import GPG GitHub Action Add author input Fix default committer and author for GitHub Actions bot Replace GITHUB_PAT env var with GH_PAT (#53) Replace committer_name and committer_email inputs with committer
2020-05-11 20:59:39 +08:00
with:
git_user_signingkey: true
git_commit_gpgsign: true
env:
GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }}
PASSPHRASE: ${{ secrets.PASSPHRASE }}
-
name: Deploy to GitHub Pages
if: success()
Update workflows
2020-05-11 21:10:43 +08:00
uses: crazy-max/ghaction-github-pages@v2
Add ability to sign commits through Import GPG GitHub Action Add author input Fix default committer and author for GitHub Actions bot Replace GITHUB_PAT env var with GH_PAT (#53) Replace committer_name and committer_email inputs with committer
2020-05-11 20:59:39 +08:00
with:
target_branch: gh-pages
build_dir: public
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
Check availability of GitHub Pages example
2020-05-24 05:15:35 +08:00
### Check availability of GitHub Pages
Update README
2020-05-24 07:22:00 +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:
Check availability of GitHub Pages example
2020-05-24 05:15:35 +08:00
```yaml
-
name: Check GitHub Pages status
uses: crazy-max/ghaction-github-status@v1
with:
pages_threshold: major_outage
-
name: Deploy to GitHub Pages
if: success()
uses: crazy-max/ghaction-github-pages@v2
with:
target_branch: gh-pages
build_dir: public
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
Update README
2020-01-23 22:11:55 +08:00
## Customizing
Initial version
2019-09-01 04:23:41 +08:00
### inputs
Add target_branch input
2019-09-01 05:28:00 +08:00
Following inputs can be used as `step.with` keys
Initial version
2019-09-01 04:23:41 +08:00
Add keep_history, allow_empty_commit and fqdn inputs (#23) Log latest changes
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`) |
Update README
2019-11-15 23:46:40 +08:00
| `allow_empty_commit` | Bool | Allow an empty commit to be created (default `true`) |
Add keep_history, allow_empty_commit and fqdn inputs (#23) Log latest changes
2019-11-15 21:40:43 +08:00
| `build_dir` | String | Build directory to deploy (**required**) |
Add ability to sign commits through Import GPG GitHub Action Add author input Fix default committer and author for GitHub Actions bot Replace GITHUB_PAT env var with GH_PAT (#53) Replace committer_name and committer_email inputs with committer
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) |
Add keep_history, allow_empty_commit and fqdn inputs (#23) Log latest changes
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 |
Add jekyll input option (#116) GitHub Pages will use Jekyll to build your site by default. This input option allows for this functionality to be disabled. The option is left to `true` by default as setting to `false` will cause the `.nojekyll` file to be written to the output directory. https://help.github.com/en/github/working-with-github-pages/about-github-pages#static-site-generators
2020-06-25 15:24:31 +08:00
| `jekyll` | Bool | Allow Jekyll to build your site (default `true`) |
Initial version
2019-09-01 04:23:41 +08:00
### environment variables
Limitation using GITHUB_TOKEN
2019-09-01 13:01:38 +08:00
Following environment variables can be used as `step.env` keys
Initial version
2019-09-01 04:23:41 +08:00
Add keep_history, allow_empty_commit and fqdn inputs (#23) Log latest changes
2019-11-15 21:40:43 +08:00
| Name | Description |
|----------------|---------------------------------------|
GITHUB_TOKEN documentation link (#90)
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` |
Add ability to sign commits through Import GPG GitHub Action Add author input Fix default committer and author for GitHub Actions bot Replace GITHUB_PAT env var with GH_PAT (#53) Replace committer_name and committer_email inputs with committer
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 |
Limitation using GITHUB_TOKEN
2019-09-01 13:01:38 +08:00
Personal Access Token is not required anymore to trigger a page build on a public repository (#1)
2020-05-04 07:33:02 +08:00
## How can I help?
Initial version
2019-09-01 04:23:41 +08:00
Update README
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:
Initial version
2019-09-01 04:23:41 +08:00
Update README
2019-11-15 02:25:19 +08:00
Thanks again for your support, it is much appreciated! :pray:
Initial version
2019-09-01 04:23:41 +08:00
Update README
2020-01-23 22:11:55 +08:00
## License
Initial version
2019-09-01 04:23:41 +08:00
MIT. See `LICENSE` for more details.
Reference in New Issue Copy Permalink