/
Analyzing a GitHub Enterprise Pull Request

Analyzing a GitHub Enterprise Pull Request

Owned by Saar Avishai (Unlicensed)
Last updated: Nov 06, 2023 by Jason Wides
4 min read

SeaLights Pull Request Integration exposes Quality Risks to the developer as part of the Pull Request process, to be displayed and handled before the code is merged into the main branch.

Note that this feature is supported from GitHub Enterprise version v2.14 and newer.

SeaLights GitHub App Setup

In order to benefit of the Pull Request Analysis, you will need to create a new App on your Github Enterprise instance.

  • This app will be used by the Sealights Task Runner to push the information to your GitHub Entreprise instance.

The application will not require any access to your source code. It only requires:

  • Read access to metadata

  • Read and write access to checks

  • Website & Website hook must be filled in

The creation of the application is a pretty simple and straightforward procedure in GitHub Entreprise settings:

  1. Open your GitHub Settings > Developer Settings > Github Apps > New GitHub App page

  2. Specify the app ID based on the following, after the application has been created:

3. The following Private Key is to be downloaded and placed in the same folder as the TaskRunner agent:

 

4. Then, navigate to Install App, and choose an account to install the SeaLights app on:

5. Select “All Repositories” in the following screen

SeaLights Task Runner App Configuration

To report the Pull Request data to SeaLights, the Task Runner must be installed locally on the GitHub server, or on a server with access to the GitHub Enterprise instance:

  1. Download the Task Runner from the following link: https://agents.sealights.co/sl_task_runner/sl_task_runner-4.0.2397.zip

  2. Prepare a configuration file to be used by the Task Runner in JSON format:

    • The GitHub Enterprise server properties in this configuration file should be defined within json property "github" as follows: