Gosh Jenkins Build for VS Code

English | 简体中文

Configure Jenkins jobs, dynamic parameters, build tracking, and artifact delivery without leaving VS Code.

Quick Start

1. Install the extension and select the Jenkins icon in the Activity Bar.
2. Select a job and enter its build parameters.
3. Select Start Build. If required, enter the Jenkins URL, username, and API token in the connection panel.
4. Track queued and running builds, then download, install, or share the resulting artifact.

Configuration

The Jenkins workbench uses a two-column layout: jobs on the left, with parameters and build tasks on the right.

When connection information is incomplete, Start Build opens a single configuration panel for:

• Jenkins URL
• Username
• API token

The panel includes token-generation instructions and a connection test. Tokens are stored only in VS Code SecretStorage, not in workspace or user setting files. You can reopen the panel with Jenkins: Configure Connection.

The extension interface follows the VS Code display language. English and Simplified Chinese are included.

Generate a Jenkins API Token

1. Sign in to Jenkins and open your user profile from the upper-right corner.
2. Open Security or Configure, then locate API Token.
3. Select Add new Token, enter a name, and select Generate.
4. Copy the token immediately and paste it into the extension's connection panel.

Jenkins normally displays the complete token only once. Revoke and regenerate it if it is lost.

Features

• Browse Jenkins jobs by group from the Activity Bar.
• Show cached parameters immediately while refreshing their definitions in the background.
• Preserve current values when a refreshed job keeps parameters with the same names.
• Support String, Text, Password, Boolean, Choice, and Git Parameter definitions.
• Trigger regular builds, current-branch builds, or paired Android and iOS builds.
• Discover queued and running tasks from Jenkins, including builds triggered outside the extension.
• Refresh elapsed time and estimated progress locally without extra Jenkins requests every second.
• Show Build Tasks and Artifact as separate tabs. Both tabs group Android and iOS jobs into product tabs such as gosh and kick; task tabs include active and total counts.
• Keep up to 200 artifact records, including iOS install manifests that have no reported size. Unknown sizes are displayed as -.
• Copy a landscape download QR poster with version, build number, platform, package type, branch, environment, operator, build time, and artifact details.
• Install APK artifacts on the only connected and authorized Android device through ADB.
• Extract APK, AAB, IPA, and iOS itms-services links from console output when Jenkins has no archived artifact.
• Write request diagnostics to the Gosh Jenkins Build output channel with sensitive parameters redacted.

Limitations

• Desktop VS Code only; vscode.dev web extensions are not supported.
• APK file-structure depth comparison from the IntelliJ plugin is not currently available.

简体中文

在 VS Code 中完成 Jenkins Job 选择、动态参数配置、构建提交、状态跟踪和产物处理。

快速开始

1. 安装插件后，点击活动栏中的 Jenkins 图标打开构建工作台。
2. 选择 Job 并填写构建参数。
3. 点击“开始构建”，在统一配置面板中补充 Jenkins 地址、用户名和 API Token。
4. 提交后可在工作台持续查看排队、构建状态和产物。

配置

点击活动栏的 Jenkins 图标会打开编辑区工作台。工作台采用左右分栏：左侧选择 Job，右侧上方填写构建参数，右侧下方跟踪构建任务和产物。

在 Jenkins Build 工作台点击“开始构建”时，如果连接信息不完整，插件会打开统一配置面板：

• Jenkins 地址
• 用户名
• API Token

配置面板包含 Jenkins API Token 生成指引并支持测试连接；保存成功后会继续本次构建。 也可以执行 Jenkins: 配置连接 主动打开该面板。Token 只保存在 VS Code SecretStorage 中，不会写入项目或普通设置文件。

插件界面跟随 VS Code 显示语言，当前提供英文和简体中文。

获取 Jenkins API Token

1. 登录 Jenkins，点击右上角用户名进入个人设置。
2. 打开 Security 或 Configure 页面，找到 API Token。
3. 点击 Add new Token，填写名称后选择 Generate。
4. 立即复制生成的 Token，并粘贴到插件配置面板。

Jenkins 通常只在生成时完整展示一次 Token；遗失后请撤销旧 Token 并重新生成。

功能

• Activity Bar 中按栏目展示 Jenkins Job。
• 切换 Job 时优先显示本地缓存的构建参数，同时后台请求最新定义。
• 参数变化时自动刷新表单，并保留同名参数的当前值。
• 支持字符串、文本、密码、布尔、Choice 和 Git Parameter。
• 支持普通构建、当前 Git 分支快速构建，以及 Android/iOS 双端构建。
• 构建任务支持 Queue 和 Build 状态轮询、停止、Jenkins 页面跳转。插件启动或刷新 Job 时会读取 Jenkins 当前全部排队和构建中的任务，之后每 12 秒后台同步一次；支持最多 5 层 Jenkins Folder，并能发现同一 Job 最近 20 次构建中的并发活动任务，其他入口提交的任务和插件重载前尚未完成的任务也会自动出现。
• 活动任务每秒刷新排队时长、开始时间、已用时和预计进度，计时刷新不额外请求 Jenkins；单个任务状态请求失败也不会阻塞其他任务和界面刷新。
• 底部提供 构建任务 和 Artifact 两个主 Tab；两页先按产品生成子 Tab，例如 gosh-android、gosh-ios 归入 gosh，产品内再按完整 Job 分组。构建任务子 Tab 同时展示进行中数量和总数，新任务所属产品会自动切到前台。
• Artifact 持久化保存最近 200 条 Android/iOS 产物记录；iOS itms-services 安装地址即使没有包大小也会记录，未知大小显示为 -，并支持下载和复制下载二维码。
• 构建结束后可点击“复制下载二维码”，直接把横版二维码海报写入系统剪贴板并粘贴发送，不再打开预览页。Android 使用包下载地址，iOS 使用完整 itms-services 安装地址；海报右侧展示版本、构建号、平台、包类型、分支、环境、操作人、打包时间和产物信息。其中操作人、开发分支和版本优先读取 Jenkins 控制台输出，构建参数仅作为兜底。
• 构建任务信息同步展示操作人、开发分支和版本，便于确认是谁基于哪个分支打包。
• 构建任务提供“安装到手机”按钮：APK 会下载到临时目录并通过 ADB 覆盖安装到唯一一台已连接且已授权的 Android 手机；未连接、未授权或同时连接多台设备时会停止并提示。iOS 产物需复制二维码图片后在 iPhone 上扫码安装。
• Jenkins 未归档产物时，会从控制台日志提取 APK/AAB/IPA 下载链接或 iOS itms-services 安装地址。
• 请求日志输出到 Gosh Jenkins Build Output Channel，敏感参数会脱敏。

当前边界

• 仅支持桌面版 VS Code，不支持 vscode.dev Web Extension 环境。
• 首期未迁移 IntelliJ 插件中的 APK 文件结构深度对比。