You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Document the necessary permission settings for GITHUB_TOKEN.
Why is this needed?
As documented in the README 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 can however have been set in the enterprise, organization, repository or workflow which may prevent this working.
Can you provide any assistance on this? It's a result of feat: [CYCLOUD-1447] Auto-detect PR numbers #1009 and I'm not sure that I understand the whole story yet, so I'm trying to reverse engineer it.
I don't know exactly what circumstances permissions are needed. In a test with all permissions disabled (permissions: {}) recording was successful. From reports of other users I know that this is not always the case.
permissions:
contents: read # This is required for actions/checkoutpull-requests: read # This is required for Cypress runactions: write # This is required for Cypress run
I published the detailed fixes in (#1272 (comment)). I applied that on my system to run the Cypress Job on GitHub Actions. Please, consider it when writing the documentation.
Activity
MikeMcC399 commentedon Oct 4, 2024
@tbiethman
permissions: {}) recording was successful. From reports of other users I know that this is not always the case.[-]Document `GITHUB_TOKEN` settings[/-][+]Document `GITHUB_TOKEN` settings - Cypress Cloud recording[/+]MikeMcC399 commentedon Oct 21, 2024
This is a topic for the Cypress Cloud team.
VolodymyrSmahliuk commentedon Jan 16, 2025
Additional permissions should be documented:
I published the detailed fixes in (#1272 (comment)). I applied that on my system to run the Cypress Job on GitHub Actions. Please, consider it when writing the documentation.