Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: default github_token to github.token #624

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from
Draft
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update github_token section
  • Loading branch information
peaceiris committed Sep 9, 2021
commit 62e5a4cc498814c25eef5dfcfacb2a13d59bdfe0
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -175,9 +175,10 @@ jobs:

### ⭐️ Set Runner's Access Token `github_token`

**This option is for `GITHUB_TOKEN`, not a personal access token.**

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.
For newbies of GitHub Actions:
Note that this option is for `GITHUB_TOKEN`, **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.

```yaml
- name: Deploy
@@ -187,7 +188,7 @@ A GitHub Actions runner automatically creates a `GITHUB_TOKEN` secret to use in
publish_dir: ./public
```

For more details about `GITHUB_TOKEN`: [Authenticating with the GITHUB_TOKEN - GitHub Help](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)
For more details about `GITHUB_TOKEN`: [Authenticating with the GITHUB_TOKEN - GitHub Help](https://docs.github.com/en/actions/reference/authentication-in-a-workflow)

### ⭐️ Set SSH Private Key `deploy_key`