Versions Compared

Old Version 5

changes.mady.by.user Marc Amouyal

Saved on

compared with

New Version 6

changes.mady.by.user Marc Amouyal

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

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

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 Appon 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

Image RemovedImage Added

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://sl-repo.s3.amazonaws.com/sl_task_runner/sl_task_runner-2.1.1368.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:

sl-taskrunner-cfg.json example:

Code Block
{
    "tokenFile": "config/sltoken.txt",
	"github":
        {
            "url": "https://github.internal.net:443",
            "owner":"repo-owner",
            "repo":"reponame",
            "appId":1,
            "privateKeyFile":"config/github-private-key"
        }
}

  • The token to be used should be an Agent token

  • Once the above steps have been completed, it’s time to run the task runner .jar file, specifying the configuration file created in the previous step:

Code Block
breakoutModewide
java -Dsl.config.file=config/sl-taskrunner-cfg.json -jar sl_task_runner.jar

It is also possible to pass the same parameters as Java properties, like in the example below

java -Dsl.tokenFile=/path/to/sltoken.txt -Dsl.github.url=http://github.internal.net:443 -Dsl.github.appId=<app ID assigned to SL app> -Dsl.github.privateKeyFile=</path/to/private-key-file> -jar sl_task_runner.jar

Info

See Task Runner Agent - Command Reference for full list of parameters

Configuring the pull request job

The pull request job needs to run the SeaLights build scan and test listener for the test stages you want the analysis on. These results will be compared to the latest build you reported to SeaLights for the branch you are merging the Pull Request to.

Note

The difference between the pull request job and standard jobs is in how the session ID is created using Pull Request specific parameters.

Generating a session ID

You create the Pull Request build session ID by using the SeaLights Java Build Scanner (See: Downloading the java agent files) with the prConfig option:

Code Block
java -jar sl-build-scanner.jar -prConfig {-token <arg> | -tokenfile <arg>} -appname <arg> -targetBranch <arg> -latestCommit <arg> -pullRequestNumber <arg> -repoUrl <arg> [-pi <arg>] [-pe <arg>]
Note

For Java applications, the packages included and excluded should be exactly the same as what was defined to SeaLights for the merged branch so that the compared results will be the same

Info

See prConfig - Command Reference for full parameter details in Java agent, node agent or via the Sealights Jenkins plugin.

Pull Request parameters explanation as seen in GitHub.com

You can easily identify the relevant values to pass to the Build Scanner based on the illustration below. The screenshot is from GitHub.com, but is relevant for On Premise solutions as well.

Image Modified

Sample of Results on GitHub's Pull Request page

At the completion of the analysis, Sealights' App will appear as part of the "Checks" of your Pull Request. Result will appear similar to the one below:

Image Modified