isabella232 / plugin-validator

Tool for validating Grafana community plugins

Grafana Plugin Validator

A tool for validating community plugins for publishing to Grafana.com.

The tool expects path to either a remote or a local ZIP archive.

Install

cd pkg/cmd/plugincheck
go install

Run

Validate a remote archive:

plugincheck https://github.com/marcusolsson/grafana-jsonapi-datasource/releases/download/v0.6.0/marcusolsson-json-datasource-0.6.0.zip

Validate a local plugin archive:

plugincheck ./marcusolsson-json-datasource-0.6.0.zip

Install V2

cd pkg/cmd/plugincheck2
go install

Run V2

Typically running the checker with default settings is the easiest method to see if there are issues with a plugin.

plugincheck2 -config config/default.yaml https://github.com/marcusolsson/grafana-jsonapi-datasource/releases/download/v0.6.0/marcusolsson-json-datasource-0.6.0.zip

To wrap the output with another tool (like the validator ui), running with the terse-json.yaml config can be used.

plugincheck2 -config config/terse-json.yaml https://github.com/marcusolsson/grafana-jsonapi-datasource/releases/download/v0.6.0/marcusolsson-json-datasource-0.6.0.zip

Verbose json output is available to show all checks made, with status for each.

plugincheck2 -config config/verbose-json.yaml https://github.com/marcusolsson/grafana-jsonapi-datasource/releases/download/v0.6.0/marcusolsson-json-datasource-0.6.0.zip

License

Grafana Plugin Validator is distributed under the Apache 2.0 License.