Grafana Publisher 镜像文档

镜像概述和主要用途

Grafana Publisher 是一个用于将插件发布到 grafana.com 的工具，支持通过命令行或在 CircleCI 环境中运行。该工具提供了一系列命令，覆盖插件发布流程的各个环节，包括环境验证、信息查询、暂存发布和正式发布等功能。

核心功能和特性

• 支持插件发布全流程管理，从环境验证到正式发布
• 提供多种命令满足不同发布场景需求
• 支持本地和远程两种发布模式
• 提供详细的日志输出和调试功能
• 支持无交互模式，适合 CI/CD 环境集成
• 提供 dryrun 模式，可预先测试发布流程
• 支持设置插件的 grafanaDependency 属性

使用场景和适用范围

• Grafana 插件开发者发布插件到 grafana.com
• 在 CI/CD 流程中集成插件自动发布步骤
• 验证插件发布环境配置
• 查询已发布或待发布插件的详细信息
• 管理插件与 Grafana 版本的依赖关系
• 测试插件发布流程而不实际执行发布操作

详细的使用方法和配置说明

基本用法

运行不带参数的应用程序将显示帮助信息：

docker run grafana/integration-plugin-publisher:latest

命令选项

环境变量

这些变量值可在 1Password 中找到，并且在每个 CircleCI 项目中已预设。

命令概述

常用命令详解

validate

验证环境变量是否存在且能正常工作，dryrun 和 publish 命令会自动运行此验证。

docker run \
  -e GCOM_PUBLISH_TOKEN=$GCOM_PUBLISH_TOKEN \
  -e GITHUB_TOKEN=$GITHUB_TOKEN \
  -e GCLOUD_SERVICE_KEY=$GCLOUD_SERVICE_KEY \
  grafana/integration-plugin-publisher:latest \
  grafana-publisher.js validate

输出示例：

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 [***]
OK: GCOM is working
Validation Successful

info

获取本地仓库中已发布插件的摘要信息，需要本地存在 plugin.json 文件且与插件 ID 匹配。

docker run \
  -v $(pwd):/workspace \
  -w /workspace \
  grafana/integration-plugin-publisher:latest \
  grafana-publisher info grafana-newrelic-datasource dist/plugin.json 2.0.5

inforemote

获取已发布插件的摘要信息，通过插件 ID 标识，可指定版本（默认为最新版本）。

docker run \
  -e GITHUB_TOKEN=$GITHUB_TOKEN \
  grafana/integration-plugin-publisher:latest \
  grafana-publisher inforemote grafana-newrelic-datasource 2.0.5

publish

执行本地插件到生产环境的发布，这是应用程序的主要功能。

docker run \
  -v $(pwd):/workspace \
  -w /workspace \
  -e GCOM_PUBLISH_TOKEN=$GCOM_PUBLISH_TOKEN \
  -e GITHUB_TOKEN=$GITHUB_TOKEN \
  -e GCLOUD_SERVICE_KEY=$GCLOUD_SERVICE_KEY \
  grafana/integration-plugin-publisher:latest \
  grafana-publisher publish grafana-newrelic-datasource 2.0.5 dist/plugin.json

publishremote

通过指定仓库 URL 和版本号，无需本地检出代码即可将插件发布到生产环境。

docker run \
  -e GCOM_PUBLISH_TOKEN=$GCOM_PUBLISH_TOKEN \
  -e GITHUB_TOKEN=$GITHUB_TOKEN \
  -e GCLOUD_SERVICE_KEY=$GCLOUD_SERVICE_KEY \
  grafana/integration-plugin-publisher:latest \
  grafana-publisher publishremote [***] 1.0.0

setdependency

设置插件的 grafanaDependency 属性，值的格式应为 >=7.0.0。

docker run \
  -e GCOM_PUBLISH_TOKEN=$GCOM_PUBLISH_TOKEN \
  -e GCOM_ADMIN_TOKEN=$GCOM_ADMIN_TOKEN \
  grafana/integration-plugin-publisher:latest \
  grafana-publisher setdependency grafana-newrelic-datasource 2.0.5 '>=7.0.0'

Docker 部署方案示例

基本验证命令

docker run \
  -e GCOM_PUBLISH_TOKEN=$GCOM_PUBLISH_TOKEN \
  -e GITHUB_TOKEN=$GITHUB_TOKEN \
  -e GCLOUD_SERVICE_KEY=$GCLOUD_SERVICE_KEY \
  grafana/integration-plugin-publisher:latest \
  grafana-publisher validate

CircleCI 环境中的使用示例

# .circleci/config.yml 片段
jobs:
  publish-plugin:
    docker:
      - image: grafana/integration-plugin-publisher:latest
    environment:
      - GCOM_PUBLISH_TOKEN: $GCOM_PUBLISH_TOKEN
      - GITHUB_TOKEN: $GITHUB_TOKEN
      - GCLOUD_SERVICE_KEY: $GCLOUD_SERVICE_KEY
    steps:
      - checkout
      - run:
          name: Publish plugin to grafana.com
          command: grafana-publisher --auto --loglevel debug publish my-plugin-id $CIRCLE_TAG dist/plugin.json

本地测试发布命令

# 测试发布（dryrun 模式）
docker run \
  -v $(pwd):/workspace \
  -w /workspace \
  -e GCOM_PUBLISH_TOKEN=$GCOM_PUBLISH_TOKEN \
  -e GITHUB_TOKEN=$GITHUB_TOKEN \
  -e GCLOUD_SERVICE_KEY=$GCLOUD_SERVICE_KEY \
  grafana/integration-plugin-publisher:latest \
  grafana-publisher --dryrun --loglevel debug publish grafana-newrelic-datasource 2.0.5 dist/plugin.json