cypress-io / cypress-io/github-action
Document `GITHUB_TOKEN` settings - Cypress Cloud recording
- Dominant language
- JavaScript
- Stars
- 1.5k
- Forks
- 353
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 27
Description
## What would you like?
Document the necessary permission settings for `GITHUB_TOKEN`.
## Why is this needed?
As documented in the README [Automatic PR number and URL detection](https://github.com/cypress-io/github-action/blob/master/README.md#automatic-pr-number-and-url-detection), if the `GITHUB_TOKEN` is set when recording to Cypress Cloud, PR information is extracted.
Restrictive [permissions for the GITHUB_TOKEN](https://docs.github.com/en/actions/security-for-github-actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) can however have been set in the enterprise, organization, repository or workflow which may prevent this working.
## Other
### Related issues
- https://github.com/cypress-io/github-action/issues/1208
Contributor guide
Assessment
This issue has not been assessed yet.