Update README.md
This commit is contained in:
parent
81110be679
commit
83eaab4031
18
README.md
18
README.md
|
@ -15,6 +15,8 @@ This deploy action can be combined simply and freely with [Static Site Generator
|
||||||
|
|
||||||
[Static Site Generators]: https://www.staticgen.com/
|
[Static Site Generators]: https://www.staticgen.com/
|
||||||
|
|
||||||
|
The next example step will deploy `./public` directory to the remote `gh-pages` branch.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- name: Deploy
|
- name: Deploy
|
||||||
uses: peaceiris/actions-gh-pages@v2.5.0
|
uses: peaceiris/actions-gh-pages@v2.5.0
|
||||||
|
@ -26,7 +28,7 @@ This deploy action can be combined simply and freely with [Static Site Generator
|
||||||
PUBLISH_DIR: ./public
|
PUBLISH_DIR: ./public
|
||||||
```
|
```
|
||||||
|
|
||||||
The above example step will deploy `./public` directory to `gh-pages` branch.
|
Three tokens are supported.
|
||||||
|
|
||||||
| Token | Private repo | Public repo | Protocol | Setup |
|
| Token | Private repo | Public repo | Protocol | Setup |
|
||||||
|---|:---:|:---:|---|---|
|
|---|:---:|:---:|---|---|
|
||||||
|
@ -34,6 +36,20 @@ The above example step will deploy `./public` directory to `gh-pages` branch.
|
||||||
| `PERSONAL_TOKEN` | ✅️ | ✅️ | HTTPS | Necessary |
|
| `PERSONAL_TOKEN` | ✅️ | ✅️ | HTTPS | Necessary |
|
||||||
| `ACTIONS_DEPLOY_KEY` | ✅️ | ✅️ | SSH | Necessary |
|
| `ACTIONS_DEPLOY_KEY` | ✅️ | ✅️ | SSH | Necessary |
|
||||||
|
|
||||||
|
Do you want to skip the docker build step? OK, the script mode is available.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- name: Deploy
|
||||||
|
env:
|
||||||
|
ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
|
||||||
|
PUBLISH_BRANCH: gh-pages
|
||||||
|
PUBLISH_DIR: ./public
|
||||||
|
SCRIPT_MODE: true
|
||||||
|
run: |
|
||||||
|
wget https://raw.githubusercontent.com/peaceiris/actions-gh-pages/v2.5.0/entrypoint.sh
|
||||||
|
bash ./entrypoint.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
Loading…
Reference in New Issue