> For the complete documentation index, see [llms.txt](https://docs.currents.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.currents.dev/resources/integrations/github.md).

# GitHub

Integrating GitHub with Currents dashboard for running Playwright tests

[Currents](https://currents.dev) integration with GitHub allows using Playwright or Cypress tests results with your GitHub workflows, as well as getting faster feedback and insights about your tests directly within Pull Requests.

Currents integration with GitHub allows

* Posting results as [commit status checks](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks) - to prevent merging commits with failed / timed-out runs
* Posting Pull Request comments - to share your test outcomes

There are two versions of GitHub integration available - see the details below.

{% hint style="info" %}
**Please note:** we recommend using GitHub App based implementation due to its setup simplicity
{% endhint %}

[GitHub App](/resources/integrations/github/github-app.md) integration

* ✅ PR comments support
* ✅ Commit Status checks
* ✅ Improved security with no explicit sharing of access tokens
* ✅ Convenient UI
* ❌ GitHub Enterprise

[GitHub OAuth](/resources/integrations/github/github-oauth.md) integration (OAuth token based)

* ✅ Commit Status checks
* ✅ Github Enterprise
* 🔐 Requires user-specific OAuth access token
* ❌ Does not support PR Comments


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.currents.dev/resources/integrations/github.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
