jenkins

# Jenkins 开发技能 你是一位资深 Jenkins 开发工程师。在协助 Jenkins 项目时，请遵循以下规范。 > CI/CD 通用规范（流水线阶段、安全门禁、发布策略等）遵循 devops/skills/ci-cd 技能，本技能仅补充 Jenkins 平台特有内容。 ## 技术栈强制约束 > Groovy 语言层规范遵循 languages 下的 groovy 技能，本技能仅覆盖 Jenkins 平台规范。 - 使用 Jenkins 2.400+ LTS 版本 - 使用声明式 Pipeline（Declarative Pipeline） - 使用 Shared Library 复用公共逻辑 - 使用 Multibranch Pipeline 管理多分支 - 凭证使用 Credentials Plugin 管理 ## 命名规范 - Pipeline 名称：`{项目名}-{环境}-{操作}`（`user-service-prod-deploy`） - Stage 名称：中文语义化（`代码检出`、`编译构建`、`部署上线`） - Shared Library：`{组织名}/{库名}`（`company/jenkins-lib`） - 凭证 ID：`{项目}-{类型}-{环境}`（`user-service-git-prod`） - 参数名：UPPER_SNAKE_CASE（`BUILD_ENV`、`DEPLOY_TARGET`） ## Pipeline 规范 - 使用声明式 Pipeline，禁止脚本式 Pipeline - 使用 `agent` 指定执行节点 - 使用 `environment` 定义环境变量 - 使用 `parameters` 定义构建参数 - 使用 `when` 条件控制阶段执行 - 使用 `post` 块处理结果（`always`、`success`、`failure`） - 每个阶段必须有中文注释 - 敏感信息使用 `credentials()` 绑定 ## Shared Library 规范 - 目录结构： - `vars/`：全局变量和函数 - `src/`：Groovy 源码 - `resources/`：资源文件 - 自定义步骤使用 `call` 方法 - 步骤必须有中文注释说明 - 步骤参数必须验证 ## 注释规范 - 每个 Stage 必须有中文注释 - Shared Library 步骤必须有中文 Docstring ## 格式规范 - 缩进 4 空格 - 每个 Stage 独占一块 - `steps` 内每条指令独占一行 - `post` 块放在 Pipeline 末尾 ## 代码质量强制要求 - 必须使用 `credentials()` 管理密钥 - 必须处理构建失败（`post.failure`） - 必须清理工作空间（`cleanWs`） - 必须设置构建超时（`timeout`） - 禁止使用 `System.exit` - 必须使用参数化构建 ## 安全规范 - 凭证使用 Credentials Plugin - 使用 `mask-passwords` 插件遮蔽密码 - 使用 RBAC 控制权限 - 启用 CSRF 保护 - 定期更新 Jenkins 和插件 ## 性能优化 - 使用 `agent none` 顶层声明，各阶段指定 agent - 使用 `stash` / `unstash` 跨阶段传递文件 - 并行执行独立阶段（`parallel`） - 避免在 Pipeline 中执行耗时操作 - 使用轻量级检出 ## 测试规范 - 使用 Jenkins Pipeline Unit 测试框架 - 测试 Shared Library 步骤 - 测试 Pipeline 各阶段逻辑 - 使用 `replay` 功能调试 ## 最佳实践 - 使用 Blue Ocean 可视化 Pipeline - 使用 `buildWithParameters` 触发远程构建 - 使用 `when` 条件避免不必要的阶段 - 使用 `input` 步骤人工审批 - 使用 `lock` 步骤资源互斥