基于Sublime Text与Jenkins API的一键触发远程编译工作流-sublime-PHP中文网

sublime text可通过自定义build_system调用curl触发jenkins构建，但必须先获取crumb并携带jenkins-crumb请求头，同时使用api token认证、正确url编码job名，并确保jenkins端启用远程触发且csrf保护配置合规。

基于sublime text与jenkins api的一键触发远程编译工作流

Sublime Text 本身不支持直接调用 Jenkins API 触发构建，但可以通过自定义 build_system 调用 curl 发送 POST 请求实现“一键触发”，关键在于权限、CSRF 保护和参数构造是否正确。

如何用 Sublime 的 Build System 调用 Jenkins REST API

Sublime 的 sublime-build 文件本质是 JSON，它能执行 shell 命令，所以核心是写一条带认证的 curl 命令。Jenkins 默认开启 CSRF 保护（crumb），直接 POST 会返回 403 No valid crumb was included in the request 错误。

必须先 GET /crumbIssuer/api/json 获取 crumb（需 Basic Auth）
再用该 crumb + 用户凭据 POST 到 /job/{jobName}/build
推荐使用 Jenkins API Token 而非明文密码，避免泄露风险
Windows 用户注意：PowerShell 对引号和转义更敏感，建议用 Git Bash 或 WSL 中的 curl

示例 sublime-build 内容（保存为 Jenkins Build.sublime-build）：

{
  "shell_cmd": "curl -u 'admin:your_api_token' -X POST 'http://jenkins.example.com/crumbIssuer/api/json' | jq -r '.crumb' | xargs -I {} curl -u 'admin:your_api_token' -H 'Jenkins-Crumb: {}' -X POST 'http://jenkins.example.com/job/webDemo/build'",
  "variants": [
    {
      "name": "With Parameters",
      "shell_cmd": "curl -u 'admin:your_api_token' -X POST 'http://jenkins.example.com/crumbIssuer/api/json' | jq -r '.crumb' | xargs -I {} curl -u 'admin:your_api_token' -H 'Jenkins-Crumb: {}' -X POST --data 'token=your_build_token&param1=value1' 'http://jenkins.example.com/job/webDemo/buildWithParameters'"
    }
  ]
}

注意：jq 是必需依赖，若未安装请改用 sed 或 Python 解析 JSON；your_api_token 需在 Jenkins 用户配置页生成，不是登录密码。

Jenkins 端必须开放的配置项

默认 Jenkins 安全策略会拦截远程 API 请求，以下三项不配齐，curl 必然失败：

Sublime Text Build Linux版

Sublime Text Linux x86-64 deb 安装包。官方也提供 rpm、tar.xz 和软件源安装方式。

下载

CSRF Protection 不能关闭，但必须通过 crumb 头传递校验值（如上所示）
Global Security → Access Control → Anonymous Read access 若勾选，可省去认证，但极不推荐
Build Triggers → Trigger builds remotely (e.g., from scripts) 必须启用，并设置 Authentication Token（用于 buildWithParameters 场景）

如果 Jenkins 启用了代理或反向代理（如 Nginx），还需确认 X-Forwarded-Proto 和 X-Forwarded-Host 头被正确透传，否则 crumb 校验可能因协议/域名不匹配而失败。