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.

Sign up for GitHub

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

Clarify token (fixes #63) #64

Merged
merged 2 commits into from
Nov 2, 2023
Merged

Clarify token (fixes #63) #64

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7e4f61f
Clarify `token` (fixes #63)
vorburger Nov 2, 2023
85739c2
Clarify how to store a custom token as secret
rossjrw Nov 2, 2023
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
18 changes: 11 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,13 +232,17 @@ the `with` parameter.
Default: The current repository that the pull request was made in.

- `token`: The token to use for the preview deployment. The default value is
fine for most purposes, but if you want to deploy the preview to a different
repository (see `deploy-repository` above), you will need to create a
[Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
with permission to access it.

Default: GITHUB_TOKEN, which gives the action permission to deploy to the
current repository.
fine for deployments to the current repository, but if you want to deploy
the preview to a different repository (see `deploy-repository` above), you
will need to create a [Personal Access
Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
with permission to access it, and [store it as a
secret](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions)
in your repository. E.g. you might name that secret 'PREVIEW_TOKEN' and
use it with `token: ${{ secrets.PREVIEW_TOKEN }}`.

Default: `${{ github.token }}`, which gives the action permission to
deploy to the current repository.

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