grafana/integration-grafana-publisher pulls statistics

Grafana Publisher

This utility can be used to publish a plugin to grafana.com either from the commandline or by running inside CircleCI.

Usage

Running the application with no arguments will provide help/usage output, which looks like this:

Flags

The following flags can assist with debugging/troubleshooting the publish process. --auto intended for use inside CircleCI, it will "answer" yes to any prompts. --dryrun this is a good commandline test to see what will happen if you attempt to publish. No action will be taken by the script, but it should let you know if the publish will succeed. --loglevel set this to debug for more output

Command Overview

The application provides mutiple commands to help all aspects of the publishing process.

Environment Variables

|ENVIRONMENT VAR | Purpose |

|GCOM_PUBLISH_TOKEN | API Key with rights to publish to grafana.com | |GCOM_ADMIN_TOKEN | API Key with admin rights to grafana.com (only for setdependency, not required for normal usage) | |GITHUB_TOKEN | API Token with release/write privileges to github repo | |GCLOUD_SERVICE_KEY | A JSON file with permission to write to integration-artifacts bucket in GCS |

These variable values can be found in 1Password, and are preset inside each CircleCI project.

validate

This command will verify if your environment variables are present and work with the APIs. This is automatically run during a dryrun and with a publish.

Output:

info

This will give you a summary of a released plugin based on a local repo. Only a "plugin.json" needs to be local and must match the plugin-id.

inforemote

This will give you a summary of a published plugin identified by plugin id. A specific version can also be requested, default is latest.

stage

Currently not implemented

stageremote

Currently not implemented

publish

This is the main function of the application. It will perform all steps needed to publish a plugin and will only error when there is a problem.

Output:

Output:

This can also be used in docker/circleci:

Output:

publishremote

setdependency

This is a single-purpose command to set the grafanaDependency value for a plugin. Value should in the form >=7.0.0

Output:

Publishing from commandline

Locally checked out release branch

Here's an example of publishing the New Relic plugin. This would be run inside the checked-out release branch, where dist is available.

Publishing with all remote resources

By specifying a repo url and a version number, the script publish to gcom without needing to have the repo checked out.

Publishing within CircleCI

Docker image

The docker image is grafana/integration-plugin-publisher:latest

Output:

Description from the Docker Hub listing.