grafana/grafana-plugin-ci

Grafana插件CI构建镜像概述

该Docker镜像专为Grafana插件开发设计，提供标准化的CI（持续集成）构建环境，解决不同CI平台间环境差异导致的构建问题。通过预装插件开发所需工具链，确保插件构建、测试、打包流程在各类CI系统（如GitHub Actions、GitLab CI、Jenkins）中保持一致，提升开发效率。

核心功能与特性

• 完整工具链预装：集成Node.js（前端开发）、Go（后端开发）、Grafana CLI（插件打包/签名）、npm/yarn（依赖管理）等核心工具，无需手动配置开发环境
• 多版本兼容性：提供不同Grafana版本对应的镜像标签（如9.5.0、10.0.0），适配插件对不同Grafana版本的兼容性需求
• CI优化设计：精简镜像体积以加速CI拉取，内置依赖缓存机制（如npm缓存目录），减少重复构建时间
• 跨平台支持：兼容Linux/amd64架构，适配主流CI平台的容器运行环境

使用场景

• 插件自动化构建：在CI流程中自动执行插件源代码编译、资源打包（如npm run build、grafana-cli plugin:build）
• 测试验证：运行单元测试（如npm test、Go测试）和集成测试，确保插件功能符合预期
• 插件签名与发布：生成符合Grafana要求的插件包（.zip格式），支持通过Grafana CLI进行官方签名，满足插件市场发布规范
• 多版本兼容性测试：通过切换镜像标签，在不同Grafana版本环境中验证插件兼容性

使用方法与配置说明

镜像拉取

从Docker仓库拉取指定版本镜像（推荐使用具体Grafana版本标签而非latest，确保构建一致性）：

bash
# 拉取Grafana 9.5.0版本对应的构建镜像
docker pull grafana/plugin-ci:9.5.0

基础使用（docker run命令）

挂载插件代码目录并执行构建命令，示例：

bash
# 假设当前目录为插件源代码根目录
docker run --rm \
  -v $(pwd):/plugin \          # 挂载本地插件代码到容器内/plugin目录
  -w /plugin \                 # 设置工作目录为插件代码目录
  -e GRAFANA_VERSION=9.5.0 \   # 指定目标Grafana版本（与镜像标签匹配）
  grafana/plugin-ci:9.5.0 \    # 使用对应版本镜像
  sh -c "npm install && npm run build && grafana-cli plugin:build"  # 构建命令序列

docker-compose配置示例

通过docker-compose.yml简化CI环境配置：

yaml
version: '3'
services:
  plugin-builder:
    image: grafana/plugin-ci:9.5.0
    volumes:
      - ./:/plugin  # 挂载插件代码目录
      - npm-cache:/root/.npm  # 持久化npm缓存，加速依赖安装
    working_dir: /plugin
    environment:
      - GRAFANA_VERSION=9.5.0
      - PLUGIN_SIGN_KEY=/run/secrets/sign-key  # 签名密钥路径（通过Docker Secrets挂载）
    command: >
      sh -c "npm install && 
             npm run test && 
             grafana-cli plugin:build && 
             grafana-cli plugin:sign --key ${PLUGIN_SIGN_KEY}"  # 构建+测试+签名流程

volumes:
  npm-cache:  # 定义npm缓存卷

环境变量配置

CI平台集成示例（GitHub Actions）

在GitHub Actions工作流中集成镜像，实现自动构建：

yaml
name: Plugin CI Build
on: [push, pull_request]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Build plugin with CI image
        uses: docker://grafana/plugin-ci:9.5.0
        with:
          args: sh -c "npm install && npm run build && grafana-cli plugin:build"
        env:
          GRAFANA_VERSION: 9.5.0
          
      - name: Upload build artifact
        uses: actions/upload-artifact@v3
        with:
          name: plugin-build
          path: dist/*.zip  # 上传构建生成的插件包

注意事项

• 镜像标签选择：生产环境建议使用具体Grafana版本标签（如9.5.0）而非latest，避免因镜像更新导致构建环境变化
• 签名密钥安全：插件签名密钥需通过CI平台的密钥管理功能（如GitHub Secrets、GitLab CI Variables）安全传递，避免硬编码在配置文件中
• 依赖缓存：在CI配置中启用依赖目录缓存（如node_modules、Go模块缓存），可显著减少构建时间
• 版本兼容性：确保镜像标签的Grafana版本与插件声明的兼容版本一致，避免API差异导致构建失败