To integrate Cypress with GitHub, we have to first install Cypress GitHub App. This can be done either from the organization integration settings or from the project settings in the Cypress Dashboard.
Installation
The installation of the Cypress GitHub App can be done in two ways. They are explained below in detail.
Installation via organization integration settings
Follow the steps mentioned below to install GitHub via organization integration settings −
- Navigate to the Dashboard Organization page.
- Choose an organization that you want to integrate with a GitHub account or organization.
- Navigate to the chosen organization’s integration option from the navigation to the side.
- Then, click the GitHub Integration button.
Installation via project settings
Follow the steps mentioned below to install GitHub via project settings −
- Choose organization inside organization switcher.
- Choose the project that you want to integrate with the repo in GitHub.
- Move to the Project settings page.
- Go to the GitHub Integration.
- Click on Install the Cypress GitHub App.
Once the GitHub App installation is done, we shall be directed to GitHub.com to proceed with further steps, which are as follows −
- Choose the GitHub organization or account for integration with the organization Cypress Dashboard.
- Next, we have to combine either all GitHub repositories or a particular repository with the Cypress GitHub App.
- Click on the Install button to finish installation.
GitHub Integration Enabling
The process to enable the GitHub integration in Cypress is explained below −
- Move to the project settings page.
- Navigate to the GitHub Integration section, then click on Configure.
- Select a repository from GitHub to integrate with the project.
- As GitHub repo is connected to a Cypress project, the GitHub integration shall be enabled.