Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
Shohei Ueda authored and GitHub committed Nov 22, 2019
1 parent 81110be commit 83eaab4
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Expand Up @@ -15,6 +15,8 @@ This deploy action can be combined simply and freely with [Static Site Generator

[Static Site Generators]: https://www.staticgen.com/

The next example step will deploy `./public` directory to the remote `gh-pages` branch.

```yaml
- name: Deploy
uses: peaceiris/actions-gh-pages@v2.5.0
Expand All @@ -26,14 +28,28 @@ This deploy action can be combined simply and freely with [Static Site Generator
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 |
|---|:---:|:---:|---|---|
| `GITHUB_TOKEN` | ✅️ | ❌️ | HTTPS | Unnecessary |
| `PERSONAL_TOKEN` | ✅️ | ✅️ | HTTPS | 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
Expand Down

0 comments on commit 83eaab4

Please sign in to comment.