> 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

Post CI test results to GitHub pull requests: a commit status, a run comment with the failed tests and a Fix link for your AI agent, and inline comments on the failing lines of the changed spec files

The Currents GitHub integration puts the results of your CI test runs on the pull request: whether the run passed, which tests failed and why, and a Fix link and prompt that hand the failures to a person or an AI agent. Reviewers see the failures on the pull request without opening the CI log.

## What Currents posts on a pull request

* **Commit status.** On by default. A status on the commit that is pending while the run is going, then passed or failed, or an error when the run timed out. Make it a required check to block merging a pull request whose tests failed. See [Commit status checks](/resources/integrations/github/github-app.md#commit-status-checks).
* **Run comment.** On by default. One comment that shows the run while it is going, then its result: the groups, the failed tests with their errors, and the flaky tests. Each test shows how often it failed or was flaky in the last 30 days. When the run has failed tests and Fix links are on, each test also links to its trace, screenshots and video. See [Run comment](/resources/integrations/github/github-app.md#run-comment).
* **Fix with AI.** On a failed run, the run comment gives you a [Fix link](/ai/agentic-testing/fix-failing-tests.md#share-a-fix-link) with the failure context and a one-line prompt to paste into your agent. Fix links are on by default. See [Fix with AI](/resources/integrations/github/github-app.md#fix-with-ai).
* **Inline comments.** Off by default. Review comments on the failing lines of the changed spec files, when those lines are in the diff. Each comment has the error summaries and a Fix with AI section. See [Inline comments on spec files](/resources/integrations/github/github-app.md#inline-comments-on-spec-files).

## Choose an integration

Currents has two GitHub integrations. Use the GitHub App unless your repositories are on GitHub Enterprise Server.

|                             | [GitHub App](/resources/integrations/github/github-app.md)         | [GitHub OAuth](/resources/integrations/github/github-oauth.md)       |
| --------------------------- | ------------------------------------------------------------------ | -------------------------------------------------------------------- |
| Commit status               | Yes                                                                | Yes                                                                  |
| Run comment and Fix with AI | Yes                                                                | No                                                                   |
| Inline comments             | Yes                                                                | No                                                                   |
| Authentication              | App installation, no token to share                                | A personal access token with the `repo:status` scope                 |
| Setup                       | Install the app from **Add Integration**, then pick the repository | Add **GitHub (Legacy)**, then enter the repository URL and the token |
| GitHub Enterprise Server    | No                                                                 | Yes                                                                  |


---

# 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.
