CI/CD / 系统课时

划清共享库与业务脚本边界

划清共享库与业务脚本边界

共享库不是把所有 Jenkinsfile 代码搬到另一个仓库。真正需要解决的是职责边界:稳定且跨项目复用的流水线能力进入共享库,强业务相关的实现留在业务仓库,而 Jenkinsfile 负责描述当前项目的交付流程。边界清楚后,复用才不会演变成强耦合。

学习目标

  • 能根据复用范围、变化频率和权限判断逻辑应放在哪里
  • 理解共享库、仓库脚本和 Jenkinsfile 各自适合承担的职责
  • 能识别共享库过度业务化和 Jenkinsfile 过度膨胀的问题

三个位置解决不同问题

Jenkinsfile 最适合表达流水线结构,例如有哪些阶段、什么时候部署以及哪个环境需要审批。它应让阅读者快速理解“这个项目怎样交付”,而不是塞入大量 Shell、构建工具或业务部署细节。

业务仓库脚本适合与应用代码共同演进的实现,例如项目自己的数据库迁移、前端资源生成或特殊打包步骤。脚本与业务代码使用同一次提交进行版本控制,检出某个应用版本时,也能拿到与之匹配的构建逻辑。

共享库则适合多个仓库都需要、接口能够稳定下来的能力,例如统一制品上传、标准通知、通用部署封装或组织级质量门禁。它可以集中修复和测试,但也意味着修改可能影响多个消费者。

Jenkins 流水线代码职责边界

用变化频率判断归属

一个逻辑被两个项目使用,并不意味着它立即应该进入共享库。先判断它是否已经形成稳定约定。如果两个项目的部署参数、目录结构和失败处理经常各自变化,过早抽象通常会产生大量条件分支。

可以用三个问题快速判断:它是否被多个项目真正重复使用;它的输入输出是否已经稳定;修改它时是否应该由平台或 CI 团队统一控制。三个答案都偏向“是”时,共享库通常更合适。

反过来,与某个应用版本紧密绑定、需要业务开发者频繁修改的逻辑,留在业务仓库通常更安全。这样一次业务变更可以同时提交代码和对应脚本,不必等待共享库发布新版本。

让 Jenkinsfile 保留业务可读性

下面的 Jenkinsfile 把通用能力交给共享库,把项目特有构建交给仓库脚本,同时保留交付阶段和生产审批,因此阅读者仍能直接看出流水线结构。

groovy
@Library('company-ci@v1.4.2') _

pipeline {
    agent any

    stages {
        stage('Build') {
            steps {
                // 项目特有构建逻辑随业务仓库一起版本化
                sh './ci/build.sh'
            }
        }

        stage('Publish') {
            steps {
                script {
                    // 制品发布规则由多个项目共享
                    publishArtifact()
                }
            }
        }

        stage('Production Approval') {
            steps {
                input message: 'Deploy to production?'
            }
        }
    }
}

执行该流水线时,Jenkinsfile 负责阶段编排;./ci/build.sh 来自当前业务仓库;publishArtifact() 来自固定版本的共享库。实际阶段耗时、工作目录和共享库检出日志会因任务配置而不同。

预期结果

text
Build 阶段执行当前仓库的 ./ci/build.sh
Publish 阶段调用 company-ci@v1.4.2 提供的 publishArtifact()
Production Approval 阶段等待人工确认

避免两种极端

第一种极端是“万能共享库”:共享函数接收大量项目名、环境名和布尔开关,内部用条件分支处理每个业务的特殊情况。此时共享库表面减少了 Jenkinsfile 代码,实际上把多个业务耦合到一个难以测试和升级的中心脚本中。

第二种极端是“万能 Jenkinsfile”:编译、制品上传、部署命令、重试、通知全部直接写在流水线文件里。这样的文件通常很快膨胀,多个项目还会复制同一套实现,修复公共问题时必须逐仓库修改。

一个实用边界是:Jenkinsfile 保留流程意图,共享库封装稳定的跨项目能力,仓库脚本承载与应用共同变化的实现。 如果某段代码尚未稳定到足以形成公共接口,就先留在业务仓库;当多个项目已经形成相同需求和调用方式后,再提炼进共享库通常成本更低。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

划清共享库与业务脚本边界

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通