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

103 lines
4.2 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)
[![Test workflow](https://github.com/crazy-max/ghaction-github-pages/workflows/test/badge.svg)](https://github.com/crazy-max/ghaction-github-pages/actions)
Initial version
2019-09-01 04:23:41 +08:00
[![Support me on Patreon](https://img.shields.io/badge/donate-patreon-f96854.svg?logo=patreon&style=flat-square)](https://www.patreon.com/crazymax)
[![Paypal Donate](https://img.shields.io/badge/donate-paypal-00457c.svg?logo=paypal&style=flat-square)](https://www.paypal.me/crazyws)
## ✨ About
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
> **:warning: Note:** To use this action, you must have access to the [GitHub Actions](https://github.com/features/actions) feature. GitHub Actions are currently only available in public beta. You can [apply for the GitHub Actions beta here](https://github.com/features/actions/signup/).
## 🚀 Usage
Update README
2019-09-05 02:19:28 +08:00
Below is a simple snippet to deploy to GitHub Pages. A [live example](https://github.com/crazy-max/ghaction-github-pages/actions) is also available for this repository.
Initial version
2019-09-01 04:23:41 +08:00
```yaml
name: website
on: push
jobs:
publish:
runs-on: ubuntu-latest
steps:
-
name: Checkout
Use v1
2019-10-11 07:51:17 +08:00
uses: actions/checkout@v1
Initial version
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>
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
-
name: Deploy
Add target_branch input
2019-09-01 05:28:00 +08:00
if: success()
Use v1
2019-10-11 07:51:17 +08:00
uses: crazy-max/ghaction-github-pages@v1
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 }}
```
## 💅 Customizing
### 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
Text
2019-10-11 08:22:34 +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`) |
| `build_dir` | String | Build directory to deploy |
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
| Name | Description |
|----------------|--------------------------------------|
| `GITHUB_TOKEN` | GITHUB_TOKEN as provided by `secrets`|
Limitation using GITHUB_TOKEN
2019-09-01 13:01:38 +08:00
| `GITHUB_PAT` | [Personal Access Token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) (see Limitation section below)|
## :warning: 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](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) and use it through the `GITHUB_PAT` environment variable:
```yaml
- name: Deploy
if: success()
Use v1
2019-10-11 07:51:17 +08:00
uses: crazy-max/ghaction-github-pages@v1
Limitation using GITHUB_TOKEN
2019-09-01 13:01:38 +08:00
with:
target_branch: gh-pages
build_dir: public
env:
GITHUB_PAT: ${{ secrets.GITHUB_PAT }}
```
Initial version
2019-09-01 04:23:41 +08:00
## 🤝 How can I help ?
All kinds of contributions are welcome :raised_hands:!<br />
The most basic way to show your support is to star :star2: the project, or to raise issues :speech_balloon:<br />
But we're not gonna lie to each other, I'd rather you buy me a beer or two :beers:!
[![Support me on Patreon](.res/patreon.png)](https://www.patreon.com/crazymax)
Update README
2019-09-01 13:33:20 +08:00
[![Paypal Donate](.res/paypal.png)](https://www.paypal.me/crazyws)
Initial version
2019-09-01 04:23:41 +08:00
## 📝 License
MIT. See `LICENSE` for more details.
Reference in New Issue Copy Permalink