GitHub OAuth
GitHub OAuth integration allows connecting you GitHub repos to Currents dashboard for sharing cypress test results as GitHub Commit Status checks.
GitHub Status check example
GitHub OAuth uses GitHub personal token-based authentication to send the results of your cypress runs to GitHub.
For share your cypress test results as a GitHub status check item:
- Open Project Settings screen and click “+ Add Integration”
- Select “GitHub (legacy)”
GitHub OAuth integration - setup example
You will need to provide the following details to activate the integration:
- Full URL of your GitHub / GitHub Enterprise repository, for example
https://github.com/currents-dev/dashboard - Optional: Status label that will be used to identify the status check item
When activated and configured properly, Currents will start sending status check updated for the associated commits.
GitHub Status Check example
To deactivate GitHub integration, simply remove the integration item from the list.
Please note: your CI environment must expose git commit information in order for cypress agent to send commit details (sha, repository url etc.) and enable the integration.
Cypress agents use https://github.com/cypress-io/commit-info package to discover git-related information.
- To expose your git information, please make sure that
.gitdirectory is present in your CI environment - You can explicitly provide git information via environment variables
branch: COMMIT_INFO_BRANCH
message: COMMIT_INFO_MESSAGE
email: COMMIT_INFO_EMAIL
author: COMMIT_INFO_AUTHOR
sha: COMMIT_INFO_SHA
timestamp: COMMIT_INFO_TIMESTAMP
remote: COMMIT_INFO_REMOTE
Last modified 1yr ago