From fe996f57a551f9a0e979f8310f96384cdee71ce2 Mon Sep 17 00:00:00 2001 From: peaceiris <30958501+peaceiris@users.noreply.github.com> Date: Sun, 3 Jan 2021 08:02:51 +0900 Subject: [PATCH] docs: notes of GITHUB_TOKEN for newbies --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index be3c39e..c94f537 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,11 @@ The next example step will deploy `./public` directory to the remote `gh-pages` publish_dir: ./public ``` +For newbies of GitHub Actions: +Note that the `GITHUB_TOKEN` is **NOT** a personal access token. +A GitHub Actions runner automatically creates a `GITHUB_TOKEN` secret to authenticate in your workflow. +So, you can start to deploy immediately without any configuration. + ### Supported Tokens Three tokens are supported. @@ -159,7 +164,7 @@ jobs: **This option is for `GITHUB_TOKEN`, not a personal access token.** -GitHub Actions runner automatically creates a `GITHUB_TOKEN` secret to use in your workflow. You can use the `GITHUB_TOKEN` to authenticate in a workflow run. +A GitHub Actions runner automatically creates a `GITHUB_TOKEN` secret to use in your workflow. You can use the `GITHUB_TOKEN` to authenticate in a workflow run. ```yaml - name: Deploy