CI/CD / 系统课时

把项目构建命令接入流水线

把项目构建命令接入流水线

项目在开发机上能够执行 Maven、Gradle 或 npm 构建后,下一步是让 Jenkins 用同一套命令稳定执行,并让命令的退出状态决定流水线结果。本节以 Maven 为主示例,建立从检出代码、执行构建到确认产物的完整链路。

学习目标

  • 将已有项目构建命令放入 Jenkins Pipeline
  • 理解进程退出码如何影响 Stage 和流水线状态
  • 验证构建成功后确实产生预期制品

从本地命令迁移到 Pipeline

接入流水线时,不要先把构建过程改造成大量 Jenkins 专用逻辑。更稳妥的做法是先确认仓库中的标准构建命令,然后让 Jenkins 调用它。例如 Maven 项目可以执行 ./mvnw clean package,Gradle 项目可执行 ./gradlew build,npm 项目则通常执行 npm ci 后再运行仓库定义的构建脚本。

关键原则是让构建规则留在项目中,Jenkins 负责调度和判断结果。这样开发机与 CI 使用相同入口,出现问题时也更容易复现。

下面的 Declarative Pipeline 假设 Maven Wrapper mvnw 已提交到仓库,并且 Jenkins Agent 已安装项目所需的 JDK。checkout scm 检出当前任务对应的源码,随后执行项目自身的构建入口。

groovy
pipeline {
    agent any

    stages {
        stage('Checkout') {
            steps {
                checkout scm
            }
        }

        stage('Build') {
            steps {
                // 使用仓库中的 Wrapper,减少对 Agent 全局 Maven 版本的依赖
                sh 'chmod +x mvnw'
                sh './mvnw --batch-mode clean package -DskipTests'
            }
        }
    }
}

预期输出

text
[INFO] BUILD SUCCESS

实际 Maven 日志会包含项目名、版本、耗时和时间戳等内容,因此这里只列出用于判断成功的稳定信息。

让退出码决定构建结果

sh 步骤默认要求命令以退出码 0 结束。构建工具返回非零退出码时,该步骤会失败,当前 Stage 被标记为失败,后续普通 Stage 不再继续执行。这正是大多数构建阶段需要的行为,不必额外解析日志中的 SUCCESS 或 ERROR 文本。

例如源码无法编译时,Maven 会返回非零退出码。此时不要用 || true、无条件 exit 0 等方式吞掉错误,否则 Jenkins 看到的是成功状态,即使制品根本没有生成。

确实需要自行处理退出码时,可以显式取得状态,但必须随后根据业务规则决定是否调用 error 终止流水线。

groovy
script {
    int status = sh(script: './mvnw --batch-mode clean package -DskipTests', returnStatus: true)
    if (status != 0) {
        error("Build command failed with exit code ${status}")
    }
}

预期结果

text
命令返回 0 时继续执行;返回非 0 时 Pipeline 在此处失败。

这是 Jenkinsfile 中的片段示例,需要放在 pipeline 的某个 stage 的 steps 中;使用 returnStatus: true 后,sh 不再自动因非零退出码抛出失败,因此必须自行处理 status。

验证真正需要的构建产物

命令成功并不一定意味着后续部署需要的文件存在。对于 Maven JAR 项目,可以在构建后检查 target 中的产物,并在需要跨 Stage 或长期保存时再使用 Jenkins 的制品能力。

最简单的验证方式是让 Shell 直接检查确定的文件路径。例如项目最终应生成 target/app.jar,可以增加:

bash
test -f target/app.jar

预期结果

text
文件存在时命令无输出并返回 0;文件不存在时返回非 0,流水线失败。

如果实际文件名包含动态版本号,应由项目构建配置提供稳定名称,或使用明确规则定位,而不是随意匹配目录中的第一个文件。这样流水线判断的是“可供后续阶段使用的制品已经产生”,而不仅是“构建工具曾经返回成功”。

接入其他构建工具时保持同一原则

换成 Gradle、npm 或其他工具时,Pipeline 的核心结构无需改变:先准备确定的依赖环境,再执行仓库定义的构建入口,最后验证退出码和产物。npm 项目尤其应在 CI 中优先使用 npm ci 按锁文件安装依赖,而不是让依赖版本随执行时间漂移。

构建阶段最终应形成一个清晰契约:输入是已检出的源码和确定的构建环境,成功结果是退出码为 0 且目标制品存在,任何一个条件不满足都让流水线失败。

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

目录与阅读设置

阅读设置

17

记录一个想法

把项目构建命令接入流水线

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

登录哪都通