Skip to content

Commit

Permalink
docs: remove github_token section
Browse files Browse the repository at this point in the history
  • Loading branch information
peaceiris committed Feb 19, 2020
1 parent d850833 commit 5ac8eda
Showing 1 changed file with 0 additions and 14 deletions.
14 changes: 0 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,6 @@ Three tokens are supported.
- [Options](#options)
- [⭐️ `deploy_key`](#%EF%B8%8F-deploy_key)
- [⭐️ `personal_token`](#%EF%B8%8F-personal_token)
- [⭐️ `github_token`](#%EF%B8%8F-github_token)
- [⭐️ Allow empty commits](#%EF%B8%8F-allow-empty-commits)
- [⭐️ Keeping existing files](#%EF%B8%8F-keeping-existing-files)
- [⭐️ Deploy to external repository](#%EF%B8%8F-deploy-to-external-repository)
Expand Down Expand Up @@ -218,19 +217,6 @@ Read [⭐️ Create SSH Deploy Key](#%EF%B8%8F-create-ssh-deploy-key), create yo
+ personal_token: ${{ secrets.PERSONAL_TOKEN }}
```

### ⭐️ `github_token`

> ⚠️ **NOTES**: `github_token` works only on a **private** repository.
>
> This action supports `GITHUB_TOKEN` but it has some problems to deploy to GitHub Pages. GitHub team is investigating that. See [Issue #9]

[Issue #9]: https://github.com/peaceiris/actions-gh-pages/issues/9

```diff
- deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+ github_token: ${{ secrets.GITHUB_TOKEN }}
```

### ⭐️ Allow empty commits

By default, a commit will not be generated when no file changes. If you want to allow an empty commit, set the optional parameter `allow_empty_commit` to `true`.
Expand Down

0 comments on commit 5ac8eda

Please sign in to comment.