# GitHub OAuth

GitHub OAuth integration allows connecting you GitHub repos to Currents dashboard for sharing Playwright test results as GitHub [Commit Status checks](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).

![GitHub Status check example](https://3745692499-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FqmFDEiUa9mr11LUlxDnt%2Fuploads%2Fo0hvXqz70MuvCVPdX758%2Fcommit-status-example_rounded.png?alt=media\&token=c608df5f-4965-428d-8f19-91166a8aa668)

GitHub OAuth uses  GitHub personal token-based authentication to send the results of your Playwright runs to GitHub.

### Activating Legacy GitHub Integration

For share your Playwright test results as a GitHub status check item:

* Open Project Settings screen and click “+ Add Integration”
* Select “GitHub (legacy)”

![GitHub OAuth integration](https://3745692499-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FqmFDEiUa9mr11LUlxDnt%2Fuploads%2FnSQO4Uuq4HTZEh6AL2en%2FScreenshot%202026-01-19%20at%2020.03.07.png?alt=media\&token=3588aeb1-77c3-47c4-84d4-f140778f4fb9)

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`
* An [OAuth GitHub token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) with `repo:status` permission for the selected repository
* **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](https://3745692499-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FqmFDEiUa9mr11LUlxDnt%2Fuploads%2FxUObrbkiNmwOVPxm3dXJ%2Fstatus-check-example.gif?alt=media\&token=7fdce33d-5c55-449a-884c-d017674adc3c)

### Deactivating GitHub OAuth Integration

To deactivate GitHub integration, simply remove the integration item from the list.

### Troubleshooting GitHub OAuth Integration

{% hint style="info" %}
**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.
{% endhint %}

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 `.git` directory 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
```