{
  "doc": {
    "id": "cloud/integrations/github",
    "title": "GitHub Integration | Cypress Documentation",
    "description": "Configure GitHub status checks and pull request comments to show Cypress test results from Cypress Cloud.",
    "section": "cloud",
    "source_path": "/llm/markdown/cloud/integrations/github.md",
    "version": "1375fa62d5875962138c8c43f27d7e1235a504a5",
    "updated_at": "2026-04-29T19:28:48.012Z",
    "headings": [
      {
        "id": "cloud/integrations/github#github-integration",
        "text": "GitHub Integration",
        "level": 1
      },
      {
        "id": "cloud/integrations/github#what-youll-learn",
        "text": " What you'll learn",
        "level": 5
      },
      {
        "id": "cloud/integrations/github#github-enterprise",
        "text": "GitHub Enterprise",
        "level": 2
      },
      {
        "id": "cloud/integrations/github#install-the-cypress-github-app",
        "text": "Install the Cypress GitHub app",
        "level": 2
      },
      {
        "id": "cloud/integrations/github#install-via-organization-integration-settings",
        "text": "Install via organization integration settings",
        "level": 3
      },
      {
        "id": "cloud/integrations/github#install-via-project-settings",
        "text": "Install via project settings",
        "level": 3
      },
      {
        "id": "cloud/integrations/github#cypress-github-app-installation-process",
        "text": "Cypress GitHub app installation process",
        "level": 3
      },
      {
        "id": "cloud/integrations/github#cypress-github-enterprise-app-installation-process",
        "text": "Cypress GitHub Enterprise app installation process",
        "level": 3
      },
      {
        "id": "cloud/integrations/github#enabling-github-integration-for-a-project",
        "text": "Enabling GitHub integration for a project",
        "level": 2
      },
      {
        "id": "cloud/integrations/github#status-checks",
        "text": "Status checks",
        "level": 2
      },
      {
        "id": "cloud/integrations/github#disable-status-checks",
        "text": "Disable status checks",
        "level": 3
      },
      {
        "id": "cloud/integrations/github#pull-request-comments",
        "text": "Pull request comments",
        "level": 2
      },
      {
        "id": "cloud/integrations/github#disable-pr-comments",
        "text": "Disable PR comments",
        "level": 3
      },
      {
        "id": "cloud/integrations/github#uninstall-the-cypress-github-app",
        "text": "Uninstall the Cypress GitHub app",
        "level": 2
      },
      {
        "id": "cloud/integrations/github#troubleshooting",
        "text": "Troubleshooting",
        "level": 2
      },
      {
        "id": "cloud/integrations/github#see-also",
        "text": "See also",
        "level": 2
      }
    ]
  },
  "content": {
    "type": "root",
    "children": [
      {
        "type": "heading",
        "depth": 1,
        "children": [
          {
            "type": "text",
            "value": "GitHub Integration"
          }
        ]
      },
      {
        "type": "heading",
        "depth": 5,
        "children": [
          {
            "type": "text",
            "value": " What you'll learn"
          }
        ]
      },
      {
        "type": "list",
        "ordered": false,
        "start": null,
        "spread": false,
        "children": [
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "How to install the Cypress GitHub App"
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "How to enable GitHub integration for a project"
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "How to configure status checks and pull request comments"
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "link",
            "title": null,
            "url": "https://on.cypress.io/cloud",
            "children": [
              {
                "type": "text",
                "value": "Cypress Cloud"
              }
            ]
          },
          {
            "type": "text",
            "value": " can integrate your Cypress tests\nwith your GitHub workflow via commit "
          },
          {
            "type": "link",
            "title": null,
            "url": "#Status-checks",
            "children": [
              {
                "type": "text",
                "value": "status checks"
              }
            ]
          },
          {
            "type": "text",
            "value": " and\n"
          },
          {
            "type": "link",
            "title": null,
            "url": "#Pull-request-comments",
            "children": [
              {
                "type": "text",
                "value": "pull request comments"
              }
            ]
          },
          {
            "type": "text",
            "value": ". A project first needs to be\n"
          },
          {
            "type": "link",
            "title": null,
            "url": "/llm/markdown/cloud/account-management/projects.md",
            "children": [
              {
                "type": "text",
                "value": "set up to record"
              }
            ]
          },
          {
            "type": "text",
            "value": " to Cypress Cloud\nto use GitHub integration."
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "The user enabling the integration must be a\nGitHub admin to enable repository access."
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "GitHub Integration depends on your CI environment reliably providing a commit\nSHA (typically via an environment variable). This is not a problem for most\nusers, but if you are facing GitHub integration issues with your CI setup,\nplease make sure the git information is being sent properly by following\n"
          },
          {
            "type": "link",
            "title": null,
            "url": "/llm/markdown/app/continuous-integration/overview.md#Git-information",
            "children": [
              {
                "type": "text",
                "value": "these guidelines"
              }
            ]
          },
          {
            "type": "text",
            "value": ".\nIf you still face issues after this, please\n"
          },
          {
            "type": "link",
            "title": null,
            "url": "mailto:hello@cypress.io",
            "children": [
              {
                "type": "text",
                "value": "contact us"
              }
            ]
          },
          {
            "type": "text",
            "value": "."
          }
        ]
      },
      {
        "type": "heading",
        "depth": 2,
        "children": [
          {
            "type": "text",
            "value": "GitHub Enterprise"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "Premium Cypress Cloud Feature"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "GitHub Enterprise integration is included in our\n"
          },
          {
            "type": "link",
            "title": null,
            "url": "https://www.cypress.io/pricing",
            "children": [
              {
                "type": "text",
                "value": "Business and Enterprise paid pricing plans"
              }
            ]
          },
          {
            "type": "text",
            "value": "."
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "To configure Cypress Cloud integration for your GitHub Enterprise site, first\nfollow the instructions to\n"
          },
          {
            "type": "link",
            "title": null,
            "url": "#Install-via-organization-integration-settings",
            "children": [
              {
                "type": "text",
                "value": "install via organization integration settings"
              }
            ]
          },
          {
            "type": "text",
            "value": "\nbelow, then skip to\n"
          },
          {
            "type": "link",
            "title": null,
            "url": "#Cypress-GitHub-Enterprise-app-installation-process",
            "children": [
              {
                "type": "text",
                "value": "Cypress GitHub Enterprise app installation"
              }
            ]
          },
          {
            "type": "text",
            "value": ",\nand finally\n"
          },
          {
            "type": "link",
            "title": null,
            "url": "#Enabling-GitHub-integration-for-a-project",
            "children": [
              {
                "type": "text",
                "value": "enable the integration for a project"
              }
            ]
          },
          {
            "type": "text",
            "value": "."
          }
        ]
      },
      {
        "type": "heading",
        "depth": 2,
        "children": [
          {
            "type": "text",
            "value": "Install the Cypress GitHub app"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "Before enabling GitHub integration for your Cypress projects, you must first\ninstall the Cypress GitHub App. You can start the GitHub App installation\nprocess via your organization's settings page or a project's settings page in\n"
          },
          {
            "type": "link",
            "title": null,
            "url": "https://on.cypress.io/cloud",
            "children": [
              {
                "type": "text",
                "value": "Cypress Cloud"
              }
            ]
          },
          {
            "type": "text",
            "value": "."
          }
        ]
      },
      {
        "type": "heading",
        "depth": 3,
        "children": [
          {
            "type": "text",
            "value": "Install via organization integration settings"
          }
        ]
      },
      {
        "type": "list",
        "ordered": true,
        "start": 1,
        "spread": true,
        "children": [
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Go to Cypress Cloud\n"
                  },
                  {
                    "type": "link",
                    "title": null,
                    "url": "https://cloud.cypress.io/organizations",
                    "children": [
                      {
                        "type": "text",
                        "value": "Organizations page"
                      }
                    ]
                  },
                  {
                    "type": "text",
                    "value": " or open the\norganization switcher."
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Select the organization you wish to integrate with a GitHub account or GitHub\norganization."
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Visit the selected organization's Integrations page via the side\nnavigation."
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Click the Install GitHub Integration or Install GitHub Enterprise\nIntegration button."
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "type": "heading",
        "depth": 3,
        "children": [
          {
            "type": "text",
            "value": "Install via project settings"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "This installation method does not apply to GitHub Enterprise."
          }
        ]
      },
      {
        "type": "list",
        "ordered": true,
        "start": 1,
        "spread": true,
        "children": [
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Select your organization in the organization switcher."
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Select the project you wish to integrate with a GitHub repository."
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Go to the project's settings page."
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Scroll down to the GitHub Integration section."
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Click the Enable GitHub button."
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "type": "heading",
        "depth": 3,
        "children": [
          {
            "type": "text",
            "value": "Cypress GitHub app installation process"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "Once you've started the GitHub App installation process\n"
          },
          {
            "type": "link",
            "title": null,
            "url": "#Install-via-organization-integration-settings",
            "children": [
              {
                "type": "text",
                "value": "via a Cypress organization's settings"
              }
            ]
          },
          {
            "type": "text",
            "value": "\nor "
          },
          {
            "type": "link",
            "title": null,
            "url": "#Install-via-project-settings",
            "children": [
              {
                "type": "text",
                "value": "a project's settings"
              }
            ]
          },
          {
            "type": "text",
            "value": ", you will be directed\nto GitHub.com to complete the installation:"
          }
        ]
      },
      {
        "type": "list",
        "ordered": true,
        "start": 1,
        "spread": true,
        "children": [
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Select the desired GitHub organization or account to integrate with your\nCypress Cloud organization."
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Choose which repositories to associate with the Cypress GitHub App. You can\nchoose All repositories or Only select repositories. with your\nCypress GitHub App installation."
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "All current and future repositories will be included with this installation if\nyou choose All repositories."
          }
        ]
      },
      {
        "type": "list",
        "ordered": true,
        "start": 3,
        "spread": false,
        "children": [
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Click the Install button to complete the installation."
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "If you are running the tests from within a restrictive VPN, see\n"
          },
          {
            "type": "link",
            "title": null,
            "url": "/llm/markdown/cloud/faq.md#Im-working-with-a-restrictive-VPN-Which-subdomains-do-I-have-to-allow-on-my-VPN-for-Cypress-Cloud-to-work-properly",
            "children": [
              {
                "type": "text",
                "value": "which subdomains to add to your allowlist for Cypress Cloud and your GitHub integration to work properly"
              }
            ]
          }
        ]
      },
      {
        "type": "heading",
        "depth": 3,
        "children": [
          {
            "type": "text",
            "value": "Cypress GitHub Enterprise app installation process"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "To integrate Cypress Cloud with GitHub Enterprise, you need to create a new\nGitHub App, copy the necessary settings and credentials from the new app, paste\nthem into Cypress Cloud, and complete the activation process."
          }
        ]
      },
      {
        "type": "list",
        "ordered": true,
        "start": 1,
        "spread": false,
        "children": [
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "With your Cypress Cloud organization's GitHub Enterprise page open, open a\nnew tab or browser window and browse to your GitHub Enterprise site. Navigate\nto your GitHub organization → Settings → Developer settings →\nGitHub Apps. Do NOT go to OAuth Apps. Click the New GitHub\nApp button."
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "type": "list",
        "ordered": true,
        "start": 2,
        "spread": false,
        "children": [
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Complete the Register new GitHub app section."
                  }
                ]
              },
              {
                "type": "list",
                "ordered": false,
                "start": null,
                "spread": false,
                "children": [
                  {
                    "type": "listItem",
                    "spread": false,
                    "checked": null,
                    "children": [
                      {
                        "type": "paragraph",
                        "children": [
                          {
                            "type": "text",
                            "value": "Enter a GitHub App name. Name may contain only dashes, letters, and\nnumbers, no spaces."
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "type": "listItem",
                    "spread": false,
                    "checked": null,
                    "children": [
                      {
                        "type": "paragraph",
                        "children": [
                          {
                            "type": "text",
                            "value": "Enter Cypress Cloud Homepage URL, "
                          },
                          {
                            "type": "link",
                            "title": null,
                            "url": "https://cloud.cypress.io",
                            "children": [
                              {
                                "type": "text",
                                "value": "https://cloud.cypress.io"
                              }
                            ]
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "type": "listItem",
                    "spread": false,
                    "checked": null,
                    "children": [
                      {
                        "type": "paragraph",
                        "children": [
                          {
                            "type": "text",
                            "value": "Enter the Callback URL and Setup URL,\n"
                          },
                          {
                            "type": "link",
                            "title": null,
                            "url": "https://cloud.cypress.io/apps/github/callback",
                            "children": [
                              {
                                "type": "text",
                                "value": "https://cloud.cypress.io/apps/github/callback"
                              }
                            ]
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "type": "list",
        "ordered": true,
        "start": 3,
        "spread": false,
        "children": [
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Complete the Webhook section."
                  }
                ]
              },
              {
                "type": "list",
                "ordered": false,
                "start": null,
                "spread": false,
                "children": [
                  {
                    "type": "listItem",
                    "spread": false,
                    "checked": null,
                    "children": [
                      {
                        "type": "paragraph",
                        "children": [
                          {
                            "type": "text",
                            "value": "Enter the Webhook URL, "
                          },
                          {
                            "type": "link",
                            "title": null,
                            "url": "https://cloud.cypress.io/webhooks/github-app",
                            "children": [
                              {
                                "type": "text",
                                "value": "https://cloud.cypress.io/webhooks/github-app"
                              }
                            ]
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "type": "listItem",
                    "spread": false,
                    "checked": null,
                    "children": [
                      {
                        "type": "paragraph",
                        "children": [
                          {
                            "type": "text",
                            "value": "Copy and paste the provided Webhook secret from Cypress Cloud to\nWebhook secret (optional)."
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "type": "list",
        "ordered": true,
        "start": 4,
        "spread": false,
        "children": [
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Set the Repository Permissions. Below are the minimum permissions\nrequired for the new GitHub App."
                  }
                ]
              },
              {
                "type": "list",
                "ordered": false,
                "start": null,
                "spread": false,
                "children": [
                  {
                    "type": "listItem",
                    "spread": false,
                    "checked": null,
                    "children": [
                      {
                        "type": "paragraph",
                        "children": [
                          {
                            "type": "text",
                            "value": "Pull requests: read & write"
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "type": "listItem",
                    "spread": false,
                    "checked": null,
                    "children": [
                      {
                        "type": "paragraph",
                        "children": [
                          {
                            "type": "text",
                            "value": "Commit statuses: read & write"
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "type": "list",
        "ordered": true,
        "start": 5,
        "spread": true,
        "children": [
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Skip to the bottom of the form and click the Create GitHub App button.\nYour new GitHub App is now created, and you'll be taken to the settings page."
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Returning to Cypress Cloud GitHub Enterprise Integration configuration\nscreen, populate the following values from your new GitHub App."
                  }
                ]
              },
              {
                "type": "list",
                "ordered": false,
                "start": null,
                "spread": false,
                "children": [
                  {
                    "type": "listItem",
                    "spread": false,
                    "checked": null,
                    "children": [
                      {
                        "type": "paragraph",
                        "children": [
                          {
                            "type": "text",
                            "value": "Copy the root URL of your GitHub Enterprise site to the Cypress GitHub\nEnterprise Server URL field."
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "type": "listItem",
                    "spread": false,
                    "checked": null,
                    "children": [
                      {
                        "type": "paragraph",
                        "children": [
                          {
                            "type": "text",
                            "value": "Copy the App ID to the Cypress GitHub Enterprise App ID field."
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "type": "listItem",
                    "spread": false,
                    "checked": null,
                    "children": [
                      {
                        "type": "paragraph",
                        "children": [
                          {
                            "type": "text",
                            "value": "Copy the Client ID to the Cypress GitHub Enterprise Client ID\nfield."
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "type": "listItem",
                    "spread": false,
                    "checked": null,
                    "children": [
                      {
                        "type": "paragraph",
                        "children": [
                          {
                            "type": "text",
                            "value": "Copy the GitHub App name to the Cypress GitHub Enterprise App name\nfield."
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "type": "listItem",
                    "spread": false,
                    "checked": null,
                    "children": [
                      {
                        "type": "paragraph",
                        "children": [
                          {
                            "type": "text",
                            "value": "Generate a new Client secret in GitHub by clicking on the Generate a new\nclient secret button. Copy the new secret into the Cypress GitHub\nEnterprise Client secret field."
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "type": "listItem",
                    "spread": false,
                    "checked": null,
                    "children": [
                      {
                        "type": "paragraph",
                        "children": [
                          {
                            "type": "text",
                            "value": "Generate a new private key in GitHub by clicking on the Generate a\nprivate key button. Open in a text editor and copy all of the content\ninto the Cypress GitHub Enterprise Private key field."
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "type": "list",
        "ordered": true,
        "start": 7,
        "spread": false,
        "children": [
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "In Cypress Cloud, click the Next Step button, and you will be taken to\nthe GitHub Enterprise app authorization page. Click the Authorize [your\napp name] button."
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "type": "list",
        "ordered": true,
        "start": 8,
        "spread": false,
        "children": [
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "On your newly-authorized GitHub App, click the Install button."
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "type": "list",
        "ordered": true,
        "start": 9,
        "spread": false,
        "children": [
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Nearly there! On the GitHub App installation page, choose whether you want to\ninstall the app against all repos or select specific ones, then click the\nInstall button."
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "All current and future repositories will be included with this\ninstallation if you choose All repositories."
          }
        ]
      },
      {
        "type": "list",
        "ordered": true,
        "start": 10,
        "spread": false,
        "children": [
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Finally, you will be returned to Cypress Cloud. Congratulations, you have\ninstalled Cypress Cloud GitHub Enterprise integration! You are now ready to\nconfigure a GitHub Integration for a project."
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "If you are running the tests from within a restrictive VPN, see\n"
          },
          {
            "type": "link",
            "title": null,
            "url": "/llm/markdown/cloud/faq.md#Im-working-with-a-restrictive-VPN-Which-subdomains-do-I-have-to-allow-on-my-VPN-for-Cypress-Cloud-to-work-properly",
            "children": [
              {
                "type": "text",
                "value": "which subdomains to add to your allowlist for Cypress Cloud and your GitHub Enterprise integration to work properly"
              }
            ]
          },
          {
            "type": "text",
            "value": "."
          }
        ]
      },
      {
        "type": "heading",
        "depth": 2,
        "children": [
          {
            "type": "text",
            "value": "Enabling GitHub integration for a project"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "After completing the Cypress GitHub App installation for your organization, you\ncan now enable GitHub Integration for any Cypress project."
          }
        ]
      },
      {
        "type": "list",
        "ordered": true,
        "start": 1,
        "spread": false,
        "children": [
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Go to the organization's Integrations page."
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "type": "list",
        "ordered": true,
        "start": 2,
        "spread": false,
        "children": [
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Scroll down to the GitHub Integration or GitHub Enterprise Integration\nsection."
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "You can quickly get to a project's GitHub Integrations settings by clicking on\nthe Configure link of the desired project within an\norganization's Integrations page:"
          }
        ]
      },
      {
        "type": "list",
        "ordered": true,
        "start": 3,
        "spread": false,
        "children": [
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Select a GitHub repository to associate with the project."
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "Once a GitHub repository is associated with a Cypress project, the GitHub\nintegration will be immediately enabled:"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "You can also see all GitHub Integration-enabled Cypress projects within your\norganizations Integrations page:"
          }
        ]
      },
      {
        "type": "heading",
        "depth": 2,
        "children": [
          {
            "type": "text",
            "value": "Status checks"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "If status checks are enabled within a project's GitHub integration settings,\nCypress Cloud will report Cypress test statuses to GitHub for related commits.\n"
          },
          {
            "type": "link",
            "title": null,
            "url": "https://help.github.com/en/articles/about-status-checks",
            "children": [
              {
                "type": "text",
                "value": "Status checks"
              }
            ]
          },
          {
            "type": "text",
            "value": " help\nprevent merging a commit or pull request into the rest of your codebase until\nall your Cypress tests have passed."
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "The Cypress GitHub App reports commit status checks in two distinct styles:"
          }
        ]
      },
      {
        "type": "list",
        "ordered": false,
        "start": null,
        "spread": true,
        "children": [
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "One check per\n"
                  },
                  {
                    "type": "link",
                    "title": null,
                    "url": "/llm/markdown/cloud/features/smart-orchestration/parallelization.md#Grouping-test-runs",
                    "children": [
                      {
                        "type": "text",
                        "value": "run group"
                      }
                    ]
                  },
                  {
                    "type": "text",
                    "value": "."
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Or one check per spec file."
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "Each status check will report the number of test failures or passes, and the\nassociated Details link will direct you to the test run's page within\nCypress Cloud to help you dig deeper into the problem via error messages, stack\ntraces, screenshots, and video recordings:"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "Debugging Cypress Cloud Test Runs?"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "Don't rely on artifact representations or reproducing failing conditions locally. Replay the test as it executed during the recorded run with full debug capability using "
          },
          {
            "type": "link",
            "title": null,
            "url": "/llm/markdown/cloud/features/test-replay.md",
            "children": [
              {
                "type": "text",
                "value": " Test Replay"
              }
            ]
          },
          {
            "type": "text",
            "value": "."
          }
        ]
      },
      {
        "type": "heading",
        "depth": 3,
        "children": [
          {
            "type": "text",
            "value": "Disable status checks"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "GitHub status checks are optional and can be disabled within a project's GitHub\nintegration settings:"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "Premium Cypress Cloud Feature"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "Reporting on flaky status checks is included in our\n"
          },
          {
            "type": "link",
            "title": null,
            "url": "https://www.cypress.io/pricing",
            "children": [
              {
                "type": "text",
                "value": "Team, Business and Enterprise paid pricing plans"
              }
            ]
          },
          {
            "type": "text",
            "value": "."
          }
        ]
      },
      {
        "type": "heading",
        "depth": 2,
        "children": [
          {
            "type": "text",
            "value": "Pull request comments"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "The Cypress GitHub App can provide detailed test information within the pull\nrequests via comments that include:"
          }
        ]
      },
      {
        "type": "list",
        "ordered": false,
        "start": null,
        "spread": false,
        "children": [
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Run context details:"
                  }
                ]
              },
              {
                "type": "list",
                "ordered": false,
                "start": null,
                "spread": false,
                "children": [
                  {
                    "type": "listItem",
                    "spread": false,
                    "checked": null,
                    "children": [
                      {
                        "type": "paragraph",
                        "children": [
                          {
                            "type": "text",
                            "value": "The associated Cypress project"
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "type": "listItem",
                    "spread": false,
                    "checked": null,
                    "children": [
                      {
                        "type": "paragraph",
                        "children": [
                          {
                            "type": "text",
                            "value": "A link to the corresponding "
                          },
                          {
                            "type": "link",
                            "title": null,
                            "url": "/llm/markdown/cloud/features/branch-review.md",
                            "children": [
                              {
                                "type": "text",
                                "value": "Branch Review"
                              }
                            ]
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "type": "listItem",
                    "spread": false,
                    "checked": null,
                    "children": [
                      {
                        "type": "paragraph",
                        "children": [
                          {
                            "type": "text",
                            "value": "Run status (passed, failed, etc.)"
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "type": "listItem",
                    "spread": false,
                    "checked": null,
                    "children": [
                      {
                        "type": "paragraph",
                        "children": [
                          {
                            "type": "text",
                            "value": "Run duration"
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "type": "listItem",
                    "spread": false,
                    "checked": null,
                    "children": [
                      {
                        "type": "paragraph",
                        "children": [
                          {
                            "type": "text",
                            "value": "Commit message and SHA"
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "type": "listItem",
                    "spread": false,
                    "checked": null,
                    "children": [
                      {
                        "type": "paragraph",
                        "children": [
                          {
                            "type": "text",
                            "value": "Committer"
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Test results:"
                  }
                ]
              },
              {
                "type": "list",
                "ordered": false,
                "start": null,
                "spread": false,
                "children": [
                  {
                    "type": "listItem",
                    "spread": false,
                    "checked": null,
                    "children": [
                      {
                        "type": "paragraph",
                        "children": [
                          {
                            "type": "text",
                            "value": "Run statistics, such as tests passed, failed, skipped, flaky, and pending."
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Tests for review:"
                  }
                ]
              },
              {
                "type": "list",
                "ordered": false,
                "start": null,
                "spread": false,
                "children": [
                  {
                    "type": "listItem",
                    "spread": false,
                    "checked": null,
                    "children": [
                      {
                        "type": "paragraph",
                        "children": [
                          {
                            "type": "text",
                            "value": "A summary of the tests that failed or are flaky"
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "type": "listItem",
                    "spread": false,
                    "checked": null,
                    "children": [
                      {
                        "type": "paragraph",
                        "children": [
                          {
                            "type": "text",
                            "value": "A link back to the associated failed or flaky test within Cypress Cloud"
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "An example of a Cypress pull-request comment can be seen below:"
          }
        ]
      },
      {
        "type": "heading",
        "depth": 3,
        "children": [
          {
            "type": "text",
            "value": "Disable PR comments"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "PR comments are optional and can be disabled if not needed within a project's\nGitHub Integration settings:"
          }
        ]
      },
      {
        "type": "heading",
        "depth": 2,
        "children": [
          {
            "type": "text",
            "value": "Uninstall the Cypress GitHub app"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "You can uninstall the Cypress GitHub app from GitHub by performing the following\nsteps:"
          }
        ]
      },
      {
        "type": "list",
        "ordered": true,
        "start": 1,
        "spread": false,
        "children": [
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Go into your organization's Settings from within GitHub."
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Click on GitHub Apps."
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Click Configure beside the Cypress app."
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "text",
                    "value": "Click Uninstall in the \"Danger Zone\" section."
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "type": "heading",
        "depth": 2,
        "children": [
          {
            "type": "text",
            "value": "Troubleshooting"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "See\n"
          },
          {
            "type": "link",
            "title": null,
            "url": "/llm/markdown/app/continuous-integration/github-actions.md#Common-Problems-and-Solutions",
            "children": [
              {
                "type": "text",
                "value": "Common GitHub Actions Problems and Solutions"
              }
            ]
          },
          {
            "type": "text",
            "value": "."
          }
        ]
      },
      {
        "type": "heading",
        "depth": 2,
        "children": [
          {
            "type": "text",
            "value": "See also"
          }
        ]
      },
      {
        "type": "list",
        "ordered": false,
        "start": null,
        "spread": false,
        "children": [
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "link",
                    "title": null,
                    "url": "https://github.com/cypress-io/github-action",
                    "children": [
                      {
                        "type": "text",
                        "value": "Cypress GitHub Action + Examples"
                      }
                    ]
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "link",
                    "title": null,
                    "url": "https://github.com/cypress-io/gh-action-and-gh-integration",
                    "children": [
                      {
                        "type": "text",
                        "value": "Example project that uses both Cypress GitHub Action and Cypress GitHub Integration"
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  },
  "token_estimate": 1997
}