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.

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

Document GITHUB_TOKEN settings - Cypress Cloud recording #1273

Open
MikeMcC399 opened this issue Oct 3, 2024 · 2 comments
Open

Document GITHUB_TOKEN settings - Cypress Cloud recording #1273

MikeMcC399 opened this issue Oct 3, 2024 · 2 comments
Labels
Cypress Cloud documentation Improvements or additions to documentation type: enhancement New feature or request

Comments

@MikeMcC399
Copy link
Collaborator

MikeMcC399 commented Oct 3, 2024

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, 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.

Other

Related issues

@MikeMcC399 MikeMcC399 added documentation Improvements or additions to documentation type: enhancement New feature or request Cypress Cloud labels Oct 3, 2024
@MikeMcC399 MikeMcC399 self-assigned this Oct 3, 2024
@MikeMcC399
Copy link
Collaborator Author

MikeMcC399 commented Oct 4, 2024

@tbiethman

  • 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.

@MikeMcC399 MikeMcC399 changed the title Document GITHUB_TOKEN settings Document GITHUB_TOKEN settings - Cypress Cloud recording Oct 4, 2024
@MikeMcC399 MikeMcC399 removed their assignment Oct 4, 2024
@MikeMcC399
Copy link
Collaborator Author

This is a topic for the Cypress Cloud team.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Cypress Cloud documentation Improvements or additions to documentation type: enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant