Skip to content

Commit

Permalink
docs: notes of GITHUB_TOKEN for newbies
Browse files Browse the repository at this point in the history
  • Loading branch information
peaceiris committed Jan 2, 2021
1 parent 852bfb8 commit fe996f5
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit fe996f5

Please sign in to comment.