docs: Add token difference table

This commit is contained in:
Shohei Ueda 2019-11-21 17:02:38 +09:00 committed by GitHub
parent 1f2f7ef05e
commit 8aea3055ca
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -20,12 +20,20 @@ This deploy action can be combined simply and freely with [Static Site Generator
uses: peaceiris/actions-gh-pages@v2.5.0
env:
ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
# PERSONAL_TOKEN: ${{ secrets.PERSONAL_TOKEN }}
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PUBLISH_BRANCH: gh-pages
PUBLISH_DIR: ./public
```
The above example step will deploy `./public` directory to `gh-pages` branch.
| Token | Private repo | Public repo | Protocol | Setup |
|---|---|---|---|---|
| `GITHUB_TOKEN` | ✅️ | ❌️ | https | Unnecessary |
| `PERSONAL_TOKEN` | ✅️ | ✅️ | https | Necessary |
| `ACTIONS_DEPLOY_KEY` | ✅️ | ✅️ | SSH | Necessary |
## Table of Contents