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
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
Select 'All repositories' or the specific list of repositories you want to receive the SeaLights Pull Request Analysis on
Configuring the pull request job
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.
Understanding the SeaLights GitHub Check Workflow
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:
Completed
All test stages completed
Indicates the analysis has finished successfully, including coverage and Quality Gates data.
In Progress
A PR build is reported or is still being processed
Reflects the initial reporting or processing phase of the PR build.
In Progress
A test stage has started and is not yet completed (or timed out)
Indicates that a test stage is currently running or awaiting completion.
Timed Out
Timeout of the last event
Triggered when no completion is reported within the expected timeframe (default 24 hours).
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
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:
Last updated
Was this helpful?