diff --git a/README.md b/README.md index 562dacd..adf9025 100644 --- a/README.md +++ b/README.md @@ -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`.