From 8aea3055caf602c1d6ceff892978fc70e11ef971 Mon Sep 17 00:00:00 2001 From: Shohei Ueda <30958501+peaceiris@users.noreply.github.com> Date: Thu, 21 Nov 2019 17:02:38 +0900 Subject: [PATCH] docs: Add token difference table --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 6fb8a74..71e8031 100644 --- a/README.md +++ b/README.md @@ -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