Jenkins Pipeline Batch Trigger

VSCode 扩展：批量触发 Jenkins Pipeline，实时监控构建状态，支持 Pre/Post Action 自动化引擎。

功能概览

安装

从 VSIX 安装

code --install-extension jenkins-batch-trigger-1.0.0.vsix

从源码构建

git clone https://github.com/Amos666/jenkins-batch-trigger.git
cd jenkins-batch-trigger
npm install
npm run compile
# F5 启动扩展开发宿主，或：
npx @vscode/vsce package --no-dependencies

快速开始

第一步：配置 Jenkins 连接

1. 点击侧边栏 Jenkins Batch 图标打开扩展
2. 点击树视图标题栏的 齿轮图标（Configure Jenkins Connection）
3. 按提示输入：
   • Jenkins URL：https://jenkins.example.com（不带末尾斜杠）
   • 用户名：你的 Jenkins 登录名
   • API Token：在 Jenkins → 用户设置 → API Token 中生成
   • 信任自签名证书：内网 Jenkins 通常选「是」

配置保存在 VSCode 全局设置中，API Token 安全存储在 SecretStorage。

第二步：组织 Pipeline 树

1. 点击树视图标题栏的 新建文件夹 图标，创建分组（如「支付线」「每日发版」）
2. 右键文件夹 → Add Job Nodes，弹出 Job 选择面板
3. 在面板中搜索、勾选需要管理的 Pipeline，确认添加
4. 树结构保存在 globalState，跨 workspace 共享

第三步：批量触发

1. 在侧边栏树中勾选要触发的 Job（支持文件夹级联选择）
2. 中央面板自动显示已选 Job 列表
3. 点击 参数 按钮设置触发参数（JSON 编辑器 + KV 快捷编辑）
4. 点击 触发选中，确认预览后批量触发
5. 状态列实时更新，构建链接可直接跳转 Jenkins 页面

使用详解

侧边栏树操作

参数系统

全局批量参数：点击工具栏「参数」按钮，支持两种编辑模式：

• JSON 编辑器：直接编辑 { "BRANCH": "main", "ENV": "prod" }
• KV 快捷编辑：逐行添加键值对

每 Job 独立参数：点击表格行的「✎ 参数」链接，为该 Job 设置专属参数（优先于全局参数）。

参数模板：配置好参数后点「＋ 存为模板」，下次一键套用。

触发预览

点击「触发选中」后会弹出确认面板，显示每个 Job 实际使用的参数（全局 or 独立），确认后才真正触发。

Pre/Post Action 系统

概念

Action 系统实现跨运行的参数闭环：

触发前 (Pre-Actions)          触发后 (Post-Actions)
┌─────────────────────┐      ┌─────────────────────┐
│ 从状态文件读取参数    │      │ 从构建日志提取参数    │
│ 注入到触发参数中      │ ──→  │ 写回状态文件         │
└─────────────────────┘      └─────────────────────┘
         ↑                            │
         └────────────────────────────┘
              下次触发自动使用

启用

1. 右键 Job 节点 → Toggle Pre/Post Actions（节点出现 ⚡ 图标）
2. 右键 → Configure Actions 打开配置面板

配置面板（4 个 Tab）

• 前置动作：配置触发前执行的 Action 列表
• 后置动作：配置构建完成后执行的 Action 列表
• 状态：查看/编辑/重置每个 Pipeline 的状态文件
• 试运行：输入模拟参数， dry-run Pre-Actions 查看渲染结果（不真正触发）

6 种 Action 类型

模板变量

所有字符串字段支持 ${...} 模板语法：

表达式	说明
${trigger.params.X}	触发时传入的参数
${state.a.b}	state 存储的值
${pipeline_params.X}	pre-action 注入的参数（post-action 中为空）
${env.VAR}	环境变量
${pipeline.name}	pipeline 名称
${pipeline.jobPath}	pipeline 路径
${run.prev.id}	上次构建 ID

配置示例：滚动部署

场景：每次触发时自动传入上次构建的变更 ID，构建完成后从日志提取新的变更 ID 存回。

Pre-Action（state_read）：

{
  "type": "state_read",
  "key": "chg_id.${trigger.params.param1}",
  "target": "pipeline_params.CHANGE_ID",
  "on_missing": "skip"
}

Post-Action（regex_extract）：

{
  "type": "regex_extract",
  "source": "pipeline_logs",
  "pattern": "CHANGE_ID=(\\w+)",
  "target": "state.chg_id.${trigger.params.param1}",
  "strategy": "last",
  "on_no_match": "warn"
}

效果：

• 第 1 次触发：状态为空，on_missing: skip 跳过注入，正常触发
• 构建完成：从日志提取 CHANGE_ID=abc123，写入 states/team-a__deploy.json
• 第 2 次触发：自动读取 chg_id.pr1 → 注入 CHANGE_ID=abc123 到触发参数

状态文件

存储在 globalStorageUri/states/<pipelineId>.json，格式：

{
  "version": 1,
  "updated_at": "2025-01-15T10:30:00.000Z",
  "last_run_id": "team-a/deploy#142",
  "chg_id": {
    "pr1": "abc123",
    "pr2": "def456"
  }
}

错误处理

• Pre-Action 失败：跳过该 Pipeline 的触发，不影响其他 Pipeline
• Post-Action 失败：所有变更缓冲，全部成功才写入状态文件（原子提交）
• 轮询超时：30 分钟未完成标记为 stale，停止监控
• Script 超时：5 秒强制终止

状态栏

底部状态栏显示两个指示器：

• 连接状态：$(server) Jenkins: jenkins.example.com — 点击打开设置
• 运行状态：
  • 空闲：$(rocket) Pipeline: 就绪
  • 运行中：$(sync~spin) Pipeline: 2 运行 / 1 队列
  • 有失败：$(error) Pipeline: 1 失败
  • 点击打开 Output Channel 查看详细日志

Output Channel

所有 Action 执行日志和构建轮询日志输出到 Pipeline Actions Output Channel：

• 状态栏点击 → 自动打开
• 或 View → Output → 选择 "Pipeline Actions"

配置项

数据存储

项目结构

src/
├── extension.ts          # 入口：命令注册、状态栏、OutputChannel
├── state.ts              # 核心状态管理：树、选择、触发、Action 集成
├── treeProvider.ts       # 侧边栏 TreeDataProvider
├── webviewProvider.ts    # 中央面板 Webview 消息桥接
├── webviewHtml.ts        # 中央面板 HTML 模板
├── jenkinsClient.ts      # Jenkins REST API 客户端
├── jobPickerPanel.ts     # Job 选择面板
├── globalStore.ts        # globalState 读写
├── types.ts              # 共享类型定义
├── actionTypes.ts        # Action 系统类型
├── actionStore.ts        # Action 文件存储（原子写）
├── actionEngine.ts       # Action 执行引擎（6 种动作）
├── actionsConfigPanel.ts # Action 配置 Webview 面板
└── buildPoller.ts        # 构建轮询器（单定时器 + 退避）
media/
└── webview-script.js     # 中央面板前端逻辑

常见问题

Q: 触发后状态一直显示 Running？ A: 检查 Jenkins 连接是否正常。自动刷新默认 30 秒一次，也可手动点刷新按钮。

Q: Pre-Action 读取状态为空？ A: 首次触发时状态文件不存在，设置 on_missing: "skip" 或 "fallback" 提供默认值。

Q: 如何查看 Action 执行详情？ A: 点击底部状态栏的 Pipeline 状态，或 View → Output → "Pipeline Actions"。

Q: 配置面板中试运行不触发？ A: 试运行（Dry Run）只执行 Pre-Actions 的模板渲染，不会真正触发 Jenkins 构建。

Q: 如何重置某个 Pipeline 的状态？ A: Configure Actions → 状态 Tab → 选择 Pipeline → 重置。

License

MIT