CI/CD / 系统课时

归档制品并关联构建编号

归档制品并关联构建编号

构建成功后只留下一个 JAR 文件还不够:团队必须知道它来自哪次 Jenkins Build、哪个提交,以及应该如何再次找到它。本节用 archiveArtifacts 保存构建产物,并把 Build 编号和 Git 提交写入制品元数据,形成可追踪的交付链路。

学习目标

  • 使用 archiveArtifacts 把构建产物保存到 Jenkins Build
  • 用 BUILD_NUMBER 与 GIT_COMMIT 建立制品追踪信息
  • 验证归档结果,并理解归档与长期制品仓库的边界

给制品留下来源信息

Jenkins 每次运行都会产生独立的 Build 编号,但如果最终制品仍然叫 app.jar,文件离开 Jenkins 后就很难仅凭文件名判断来源。更稳妥的做法是把构建编号用于制品命名,同时生成一个元数据文件记录提交 SHA。

下面的 Pipeline 假设 Maven 项目最终生成 target/app.jar。BUILD_NUMBER 是 Jenkins 提供的环境变量;使用 checkout scm 后,可以通过 Git 命令取得当前检出的提交。

groovy
pipeline {
    agent any

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

        stage('Build') {
            steps {
                sh 'mvn -B clean package -DskipTests'
                sh '''
                    mkdir -p dist
                    cp target/app.jar "dist/app-${BUILD_NUMBER}.jar"
                    git rev-parse HEAD > dist/git-commit.txt
                    printf '%s\n' "${BUILD_NUMBER}" > dist/jenkins-build.txt
                '''
            }
        }

        stage('Archive') {
            steps {
                archiveArtifacts artifacts: 'dist/*', fingerprint: true
            }
        }
    }
}

预期结果:假设当前构建编号为 <ID>,归档内容包含带 Build 编号的 JAR,以及记录提交和构建编号的两个文本文件。提交 SHA 和编号会随实际构建变化。

text
dist/app-<ID>.jar
dist/git-commit.txt
dist/jenkins-build.txt

这里的 fingerprint: true 会让 Jenkins 为归档文件记录指纹信息,可用于 Jenkins 内部追踪制品在不同构建之间的使用关系。它不能替代 Git 提交、版本号等业务上可读的来源信息,因此两类信息可以同时保留。

建立 Build、提交与制品的关系

一次可追踪构建至少要回答三个问题:谁生成了制品、代码来自哪里、最终保存了什么。Jenkins Build 编号标识流水线运行,Git SHA 标识源代码快照,归档文件则是这次运行产生的实际结果。

Jenkins 构建与制品追踪关系

不要只依赖 Build 编号表达代码版本。Build <ID> 只在对应 Jenkins Job 的上下文中有意义,而 Git SHA 可以准确定位代码快照。反过来,只记录 Git SHA 也不够,因为同一个提交可能因参数、依赖或环境变化被构建多次。把两者一起保存,排查问题时才能回到准确的流水线执行记录。

验证归档是否完整

归档前最好先验证文件确实存在,否则错误的 glob 或构建输出路径会让制品阶段失败。对于上面的目录,可以在工作区执行:

bash
ls -1 dist/

预期输出如下,其中 <ID> 是实际 Jenkins Build 编号。

text
app-<ID>.jar
git-commit.txt
jenkins-build.txt

随后 archiveArtifacts artifacts: 'dist/*' 会把这些文件关联到当前 Build。若归档步骤提示找不到匹配文件,应先检查 Maven 实际输出文件名、复制步骤和 dist 目录,而不是扩大通配符去掩盖路径错误。

归档不等于制品仓库

archiveArtifacts 很适合保存与 Jenkins Build 直接关联的构建结果,例如测试包、安装包或诊断文件,但它依赖 Jenkins 的构建与保留策略。构建记录被清理时,相应归档也可能随之消失,因此不能默认把 Jenkins 当作永久制品仓库。

需要跨环境发布、长期保存、权限治理或版本化下载时,应把正式制品推送到专用制品仓库,并继续携带版本、Git SHA 和 Jenkins Build 等追踪信息。Jenkins 归档负责回答“这次构建产生了什么”,专用仓库则负责管理进入交付流程的长期制品。

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

目录与阅读设置

阅读设置

17

记录一个想法

归档制品并关联构建编号

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

登录哪都通