> For the complete documentation index, see [llms.txt](https://docs.sealights.io/knowledgebase/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sealights.io/knowledgebase/setup-and-configuration/integrations/pull-request-integration/github-plugin-sealights-pull-request-checks.md).

# GitHub Plugin: SeaLights Pull Request Checks

SeaLights' GitHub.com plugin enhances your Pull Request (PR) workflow by integrating automated quality insights directly into GitHub Checks. This enables developers to identify and address quality risks before merging code into the main branch.

This integration is available for **GitHub Cloud** only, and only an organization owner can install the app.

## SeaLights GitHub App Installation <a href="#sealights-github-app-installation" id="sealights-github-app-installation"></a>

To benefit from the Pull Request Analysis, first install the Sealight's Github App on your Github organization account from the following link: <https://github.com/apps/sealights-pull-request-analysis>

<figure><img src="/files/47t4kxTi7yMjvusGyrPM" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
The app does **not** access your source cod&#x65;**.** It only requires:

* **Read** access to repository **metadata**

* **Read** and **write** access to **GitHub Checks**
  {% endhint %}

* Select **'All repositories**' **or the specific list of repositories** you want to receive the SeaLights Pull Request Analysis on

<figure><img src="/files/swjWdw02vF8AbD4jgJhR" alt=""><figcaption></figcaption></figure>

## Configuring the pull request job <a href="#configuring-the-pull-request-job" id="configuring-the-pull-request-job"></a>

To enable SeaLights analysis in your CI pipeline, configure your pull request jobs to include the SeaLights build scan and run the test listener during the relevant test stages. The results from these runs are then compared against the latest build reported to SeaLights for the target branch of the pull request. The only difference from standard SeaLights jobs is how the **Build Session ID** is generated using PR-specific parameters. For detailed setup instructions, refer to: [Configure Pull Request Flow for SeaLights](/knowledgebase/setup-and-configuration/integrations/pull-request-integration/configure-pull-request-flow-for-sealights.md).

## Understanding the SeaLights GitHub Check Workflow <a href="#understanding-the-sealights-github-check-workflow" id="understanding-the-sealights-github-check-workflow"></a>

SeaLights uses GitHub Checks to provide real-time feedback on the status of your PR analysis. These checks appear in the **Checks** tab of your Pull Request and reflect the current state of the build and test stages. The table below outlines the possible statuses, the events that trigger them, and what they represent:

<table><thead><tr><th width="119.62890625">Status</th><th width="269.5">Event</th><th>Description</th></tr></thead><tbody><tr><td><strong>Completed</strong></td><td>All test stages completed</td><td>Indicates the analysis has finished successfully, including coverage and Quality Gates data.</td></tr><tr><td><strong>In Progress</strong></td><td>A PR build is reported or is still being processed</td><td>Reflects the initial reporting or processing phase of the PR build.</td></tr><tr><td><strong>In Progress</strong></td><td>A test stage has started and is not yet completed (or timed out)</td><td>Indicates that a test stage is currently running or awaiting completion.</td></tr><tr><td><strong>Timed Out</strong></td><td>Timeout of the last event</td><td>Triggered when no completion is reported within the expected timeframe (default 24 hours).</td></tr></tbody></table>

SeaLights automatically manages the transition between these states. The timeout mechanism ensures that checks do not remain indefinitely in an "In Progress" state, providing clear and timely feedback to developers during the Pull Request lifecycle.

## Sample of Checks Results on PR page <a href="#sample-of-checks-results-on-pr-page" id="sample-of-checks-results-on-pr-page"></a>

Once analysis is complete, the SeaLights GitHub Check appears in the **Checks** section of your Pull Request - including Coverage summary, Quality Gates results, and Direct links to the SeaLights dashboard for deeper insights. The result will appear similar to the one below:

<figure><img src="/files/TzLmlobnkmcFpJA6Yxwb" alt=""><figcaption></figcaption></figure>


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.sealights.io/knowledgebase/setup-and-configuration/integrations/pull-request-integration/github-plugin-sealights-pull-request-checks.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.