Skip to content

Commit 2150c59

Browse files
authored
Merge pull request #64 from vorburger/patch-2
Clarify `token` (fixes #63)
2 parents cf53cea + 85739c2 commit 2150c59

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -232,13 +232,17 @@ the `with` parameter.
232232
Default: The current repository that the pull request was made in.
233233

234234
- `token`: The token to use for the preview deployment. The default value is
235-
fine for most purposes, but if you want to deploy the preview to a different
236-
repository (see `deploy-repository` above), you will need to create a
237-
[Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
238-
with permission to access it.
239-
240-
Default: GITHUB_TOKEN, which gives the action permission to deploy to the
241-
current repository.
235+
fine for deployments to the current repository, but if you want to deploy
236+
the preview to a different repository (see `deploy-repository` above), you
237+
will need to create a [Personal Access
238+
Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
239+
with permission to access it, and [store it as a
240+
secret](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions)
241+
in your repository. E.g. you might name that secret 'PREVIEW_TOKEN' and
242+
use it with `token: ${{ secrets.PREVIEW_TOKEN }}`.
243+
244+
Default: `${{ github.token }}`, which gives the action permission to
245+
deploy to the current repository.
242246

243247
- **(Advanced)** `action`: Determines what this action will do when it is
244248
executed. Supported values: `deploy`, `remove`, `none`, `auto`.

0 commit comments

Comments
 (0)