nvborisenko / gauge-repository Goto Github PK

View Code? Open in Web Editor NEW

Installation details of gauge plugins and language runners

Shell 1.90% JavaScript 10.56% Ruby 40.43% Python 19.42% Java 14.62% C# 7.37% TypeScript 5.71%

gauge-repository's Introduction

Gauge-Repository

This contains the meta-data of gauge plugins and language runners which is used during installation and upgrades.

Steps to add new plugin details

Add a file with name {plugin_name}-install.json in the base directory.
Following snippet shows the json format for the above file.

{
    "name": "{plugin_name}",
    "description": "{description}",
    "versions": [
        {
            "version": "{version_number}",
            "gaugeVersionSupport": {
                "minimum": "{minimum gauge version supported}",   //mandatory
                "maximum": "{maximum gauge version supported}"    //optional
            },
            "install": {
                //Command to start the plugin which should be relative to plugin directory
                "windows": [],
                "linux": [],
                "darwin": []
            },
            "DownloadUrls": {
                //Download url for each platform, if the links are not present,
                //gauge assumes the plugin does not support that platform.
                "x86": {
                    "windows": "",  
                    "linux": "",
                    "darwin": ""
                },
                "x64": {
                    "windows": "",
                    "linux": "",
                    "darwin": ""
                }
            }
        }
    ]
}