Integrating Currents dashboard with GitLab
Currents Dashboard integration with GitLab allows posting commit build statuses as well merge request comments with a summary of your cypress tests.
Cypress GitLab Integration - commit build status example
Cypress GitLab Integration - Merge Request comment example
In order to install GitLab integration in Currents Dashboard, visit Project Settings -> Integrations and click Connect GitLab repositories.
Installing GitLab integration for Cypress
GitLab Enterprise and self-hosted GitLab users: you'd override the default GitLab Instance Domain with the base URL of your GitLab setup. For example
https://hub.currents.dev/gitlab/callbackas Redirect URI
apiscope in the application permissions
apiscope is required for the integration to work correctly. At the time of implementation, GitLab didn't allow setting more granular permissions.
Here's the list of API calls that Currents use:
- Getting the list of repositories accessible to OAuth token issuer
- Posting commit build status updates
- Posting and deleting Merge Request notes
Enter the details (App ID and App Secret) of the newly created GitLab OAuth App and click Connect.
After a successful connection, you will see a dropdown list of accessible GitLab projects (repositories). Select the repository you'd like to integrate with the Currents project and click Save.
Installing GitLab Integration with Cypress
Currents Dashboard will start posting commit build statuses and merge request comments with a summary of your cypress tests for Merge Requests in the selected project.
Toggling GitLab Integration settings change the type of content that is being posted to GitLab
Customizing GitLab Integration
- Merge Requests Comment - will toggle on / off posting run results summary to a merge request
- Commit Status - will toggle on / off updating commit status with run results
Clicking Disconnect Project (1) will detach the integration from the currently selected GitLab project. Disconnecting a project would keep GitLab OAuth App credentials. You would still be able to select a different GitLab project from the list to reactivate the integration.
Uninstalling (2) the integration removes the associated credentials and the integration altogether.
Disabling GitLab Integration