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:

Usage: grafana-publisher [options] [command]

Grafana Plugin Publisher

Options:
  -V, --version                                              output the version number
  -a, --auto                                                 Run without prompts
  -l, --log [logfile]                                        log to file
  --loglevel [info|debug]                                    log level
  -d, --dryrun                                               Run but do not apply actions
  -h, --help                                                 display help for command

Commands:
  validate                                                   Detect environment settings required to run this
                                                             application
  info <pluginid> [pluginPath] [pluginVersion]               Gathers and displays known information about specified
                                                             plugin
  inforemote <pluginid> [pluginVersion]                      Gathers and displays known information about specified
                                                             plugin
  stage <pluginid> [pluginVersion]                           Performs publish to staging environment
  stageremote <pluginRepo> [pluginVersion]                   Performs remote publish to staging
  publish <pluginid> [pluginVersion] [pluginPath]            Performs local publish to production
  publishremote <pluginRepo> [pluginVersion]                 Performs remote publish to production
  setdependency <pluginid> <pluginVersion> <grafanaVersion>  Sets grafanaDependency attribute (>=7.0.0)
  help [command]                                             display help for command

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.

grafana-publisher.js validate

Output:

OK: Publish to GCOM Key found in environment setting
OK: GCS Authentication found in environment setting
OK: GIT Key found in environment setting
[2020-07-25T05:51:54.047] [DEBUG] publisher - GCOM testing GET to https://grafana.com/api/plugins/table
OK: GCOM is working
Validation Successful

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.

grafana-publisher info grafana-newrelic-datasource dist/plugin.json 2.0.5

[2020-07-21T14:23:01.860] [INFO] publisher - Gathering data for grafana-newrelic-datasource
[2020-07-21T14:23:01.863] [DEBUG] publisher - Checking testdata/newrelic/plugin.json
[2020-07-21T14:23:01.863] [DEBUG] publisher - Found file, reading...
[2020-07-21T14:23:01.863] [DEBUG] publisher - Read file, found id grafana-newrelic-datasource
[2020-07-21T14:23:01.863] [DEBUG] publisher - PluginID: grafana-newrelic-datasource
[2020-07-21T14:23:01.863] [DEBUG] publisher - Checking for grafana-newrelic-datasource for ./git/config
[2020-07-21T14:23:01.863] [DEBUG] publisher - Git Repo from predefined list:
[2020-07-21T14:23:01.863] [DEBUG] publisher - Git Repo: newrelic-datasource
[2020-07-21T14:23:01.864] [DEBUG] publisher - Repo: newrelic-datasource
[2020-07-21T14:23:01.864] [DEBUG] publisher - No dependency specified
[2020-07-21T14:23:01.864] [WARN] publisher - Dependency: Not Found!
[2020-07-21T14:23:01.864] [DEBUG] publisher - Fetching info for newrelic-datasource from https://api.github.com/repos/grafana/newrelic-datasource/releases/latest
[2020-07-21T14:23:02.158] [DEBUG] publisher - Release Tag URL: https://github.com/grafana/newrelic-datasource/releases/tag/v2.0.5
[2020-07-21T14:23:02.158] [INFO] publisher - RepoURL: https://github.com/grafana/newrelic-datasource/
[2020-07-21T14:23:02.158] [INFO] publisher - Version Detected: 2.0.5
[2020-07-21T14:23:02.158] [DEBUG] publisher - GetReleaseCommitSHA: Fetching info for newrelic-datasource version 2.0.5
[2020-07-21T14:23:02.599] [INFO] publisher - Commit Hash: 95d9fed4226f14d0f5c612b64c872470104a2870

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.

grafana-publisher publish

Output:

```…