Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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:

...

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://

...

  1. agents.

...

  1. sealights.

...

  1. co/sl_task_runner/sl_task_runner-

...

  1. 4.

...

  1. 0.

...

  1. 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:

sl-taskrunner-cfg.json example:

Code Block
{
    "tokenFile": "config/sltoken.txt",
	"github":
        {
            "url": "https://github.internal.net:443/api/v3",
            "owner":"repo-owner",
            "repo":"reponame",
            "appId":1,
            "privateKeyFile":"config/github-private-key"
        }
}
  • The token to be used should be an Agent token

  • The value of the URL should be the on prem Github API url

  • 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:

...

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/api/v3 -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

...

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

The 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

...