sinlov/woodpecker-plugin-env

Woodpecker Plugin Env 镜像文档

概述

Woodpecker Plugin Env 是一款针对 Woodpecker CI 的环境变量管理插件，主要用于在 CI/CD 工作流中打印指定环境变量、检查非空环境变量，支持 Docker 和 Local 两种后端运行模式，帮助开发者调试和验证环境配置。

核心功能与特性

• 环境变量打印：可指定需要打印的环境变量键列表，清晰展示关键环境变量值。
• 非空环境变量检查：支持检查指定环境变量是否非空（v1.7.0+版本支持），确保关键配置存在。
• 多后端兼容：适配 Docker 后端（直接使用镜像）和 Local 后端（本地安装后运行）。
• 调试支持：提供 debug 模式，开启后可进行文件浏览器调试，支持工作流步骤传输相关配置。

使用场景与适用范围

适用于基于 Woodpecker CI 的各类 CI/CD 工作流，尤其适合需要：

• 调试环境变量配置是否正确的场景。
• 确保构建、测试等步骤中关键环境变量（如 GOPATH、GOPRIVATE）已设置的场景。
• 在多步骤工作流中传递或验证环境变量的场景。

使用方法与配置说明

1. Docker 后端工作流配置

当 Woodpecker CI 使用 Docker 后端时，直接通过镜像引用插件即可。

配置示例

yaml
labels:
  backend: docker
steps:
  woodpecker-plugin-env:
    image: sinlov/woodpecker-plugin-env:latest
    pull: false  # 可选，是否拉取最新镜像，默认true
    settings:
      # debug: true  # 可选，开启调试模式，默认false
      # not-empty-envs:  # 可选，检查非空环境变量列表（v1.7.0+）
      #   - WOODPECKER_AGENT_USER_HOME
      env-printer-print-keys:  # 必选/可选，指定需打印的环境变量键
        - GOPATH
        - GOPRIVATE
        - GOBIN
      # env-printer-padding-left-max:  # 可选，左侧填充最大长度
        # from_secret: secret_printer_padding_left_max  # 可从密钥获取值
      steps-transfer-demo: false  # 可选，是否显示步骤传输演示，默认false

2. Local 后端工作流配置

当 Woodpecker CI 使用 Local 后端时，需先本地安装插件并确保其在环境变量 PATH 中。

本地安装

• 安装最新版本至 ${GOPATH}/bin：

  bash
  go install -a github.com/woodpecker-kit/woodpecker-plugin-env/cmd/woodpecker-plugin-env@latest
  

• 安装指定版本（如 v1.0.0）：

  bash
  go install -v github.com/woodpecker-kit/woodpecker-plugin-env/cmd/woodpecker-plugin-env@v1.0.0
  

配置示例

yaml
labels:
  backend: local
steps:
  woodpecker-plugin-env:
    image: woodpecker-plugin-env  # 本地已安装的插件名称
    settings:
      # debug: false  # 可选，关闭调试模式，默认false
      # not-empty-envs:  # 可选，检查非空环境变量列表（v1.7.0+）
      #   - WOODPECKER_AGENT_USER_HOME
      env-printer-print-keys:  # 必选/可选，指定需打印的环境变量键
        - GOPATH
        - GOPRIVATE
        - GOBIN
      env-printer-padding-left-max: 36  # 可选，左侧填充最大长度，如36
      steps-transfer-demo: false  # 可选，是否显示步骤传输演示，默认false

关键配置参数说明

settings.debug

• 类型：布尔值（true/false）
• 描述：开启后插件将尝试使用 override 进行文件浏览器调试。

settings.not-empty-envs

• 类型：字符串数组
• 版本要求：v1.7.0+
• 描述：指定需检查非空的环境变量列表，确保关键环境变量已设置。

settings.env-printer-print-keys

• 类型：字符串数组
• 描述：指定需打印的环境变量键，用于展示指定环境变量的值。

settings.env-printer-padding-left-max

• 类型：整数
• 描述：设置打印环境变量时左侧填充的最大长度，可通过 from_secret 从密钥获取值。

settings.steps-transfer-demo

• 类型：布尔值（true/false）
• 描述：是否开启步骤传输演示模式，默认关闭（false）。

settings.woodpecker_kit_steps_transfer_disable_out

• 类型：布尔值（true/false）
• 描述：开启后禁用 wd_steps_transfer 的输出。