楔子

上篇文章解决了提交/合并请求自动触发的需求,但所有前端模块都在同一个代码仓库里,如何获取变更文件路径确定要发布哪个模块呢?本文将带你解决这个问题。

思路

分别解决 3 个问题:

  1. 获取变更的文件列表
  2. 根据文件列表判断所属模块
  3. 构建与发布脚本

过程

GitLab 事件触发 Jenkins 构建只是一个启动信号,获取变更文件列表需要知晓上一次构建时某个仓库的版本号,这里 Jenkins 的插件 git-plugin 已经帮我们实现了这部分工作。所以只需要通过 git-plugin 检出代码即可。

检出代码

    checkout([
$class: 'GitSCM',
branches: [[name: "*/$branchName"]],
doGenerateSubmoduleConfigurations: false,
extensions: [
[$class: 'RelativeTargetDirectory',
relativeTargetDir: "$relativeTarget"]
],
submoduleCfg: [],
userRemoteConfigs: [
[credentialsId: "$credentialsId", url: "$gitUrl"]
]
])

请自行替换 $branchName 为分支名,$relativeTarget 为检出相对路径,$credentialsId 为用户凭据, $gitUrl 即 GIT仓库地址。

获取变更文件列表

//获取变更文件列表,返回HashSet,注意添加的影响文件路径不含仓库目录名
@NonCPS
def getChangeFilePathSet() {
def changedFiles = new HashSet<String>();
echo "开始获取变更的文件列表"
for (int i = 0; i < currentBuild.changeSets.size(); i++) {
def entries = currentBuild.changeSets[i].items
for (int j = 0; j < entries.length; j++) {
def entry = entries[j]
changedFiles.addAll(entry.getAffectedPaths());
}
}
println '输出修改文件列表:' + changedFiles
return changedFiles;
}

这个方法可以放到 pipeline 块外,直接在 script 块中引用。实现思路是访问 currentBuild.changeSets 获取所有本次构建相比上次构建的变更列表,返回的是 HashSet 是为了方便,用其他容器也是可以的。

注意:变更文件列表的各个文件是相对于它所在仓库的路径!

变更文件列表截字符串,获取模块列表并去重

//获取合并报表前端自动发布模块set集合。
//pathPrefix为模块路径前缀,如develop/@gc
@NonCPS
def getAutoPublishModuleSet(pathPrefix) {
//使用Set容器去重,保证待发布模块只有一份
def modulePaths = new HashSet<String>();
for(def filePath in getChangeFilePathSet()){
//忽略非前端模块的文件,比如 Jenkinsfile 等
if(filePath.startsWith(pathPrefix)){
//从超过模块前缀长度的下标开始,获取下一个/的位置。即分串位置
int index = filePath.indexOf('/', pathPrefix.length()+1)
//分串得到模块路径,比如 develop/@gc/test
def modulePath = filePath.substring(0, index)
println 'add module path: ' + modulePath
modulePaths.add(modulePath)
}
}
println '输出待发布模块列表:' + modulePaths
return modulePaths;
}

写个构建发布 Shell 脚本

publish-web-module.sh

#!/bin/bash
#此脚本用于构建发布前端模块,@author: Hellxz
#$1:发布版本/$2:模块目录
set -eu echo "------------开始发布$2模块------------>"
cd $2
echo "清理dist node_modules package-lock.json ……"
rm -rf dist node_modules package-lock.json
echo "正在安装依赖 ……"
npm i
echo "开始构建 ……"
npm run build:dev
echo "开始发布 ……"
npm --no-git-tag-version version $1
npm publish
echo "<------------发布$2模块完成------------" cd ${WORKSPACE}/web; #回到前端源码目录
exit 0;

循环调用构建发布脚本

for(def modulePath in modulePaths){
sh label: "构建发布前端模块 ${publishVersion} ${modulePath}",
script: "bash ${SHELL_PATH}/publish-web-module.sh ${publishVersion} ${modulePath}"
}

流水线示例

需将下列 Jenkinsfile 与 publish-web-module.sh 提交到同一仓库中

Jenkinsfile

pipeline{
agent any;
environment{
gitUrl="http://xxxxxxxx/xxxx/web.git"
branchName=dev
relativeTarget="web"
credentialsId=credentials('git-user')
pathPrefix="develop/@gc"
publishVersion="v1.0"
npmRepo="http://xxxxxx/nexus/repository/npm-public/"
npmToken=credentials('npm-token')
shellPath="${WORKSPACE}/jenkins" //脚本与Jenkinsfile在同级目录中
}
stages{
stage("检出代码"){
steps{
script {
cleanWs()
checkoutRepo("master", "jenkins", "${credentialsId}", "http://xxxxxxxx/xxxx/jenkins.git")
checkoutRepo("${branchName}", "${relativeTarget}", "${credentialsId}", "${gitUrl}")
}
}
}
stage("构建发布"){
steps{
script{
sh label: "设置npm仓库", script: "npm set registry ${npmRepo}"
sh label: "登录npm仓库", script: "npm config set //xxxxxx/nexus/repository/npm-public/:_authToken ${npmToken}"
def modulePaths = getAutoPublishModuleSet(env.pathPrefix)
for(def modulePath in modulePaths){
sh label: "构建发布前端模块 ${publishVersion} ${modulePath}",
script: "bash ${shellPath}/publish-web-module.sh ${publishVersion} ${modulePath}"
}
}
}
post{
always{
script{
cleanWs()
}
}
}
}
}
} //抽取检出代码方法
@NonCPS
def checkoutRepo(branchName, relativeTarget, credentialsId, gitUrl){
checkout([
$class: 'GitSCM',
branches: [[name: "*/$branchName"]],
doGenerateSubmoduleConfigurations: false,
extensions: [
[$class: 'RelativeTargetDirectory',
relativeTargetDir: "$relativeTarget"]
],
submoduleCfg: [],
userRemoteConfigs: [
[credentialsId: "$credentialsId", url: "$gitUrl"]
]
])
} //获取变更文件列表,返回HashSet,注意添加的影响文件路径不含仓库目录名
@NonCPS
def getChangeFilePathSet() {
def changedFiles = new HashSet<String>();
echo "开始获取变更的文件列表"
for (int i = 0; i < currentBuild.changeSets.size(); i++) {
def entries = currentBuild.changeSets[i].items
for (int j = 0; j < entries.length; j++) {
def entry = entries[j]
changedFiles.addAll(entry.getAffectedPaths());
}
}
println '输出修改文件列表:' + changedFiles
return changedFiles;
} //获取合并报表前端自动发布模块set集合。
@NonCPS
def getAutoPublishModuleSet(pathPrefix) {
//使用Set容器去重,保证待发布模块只有一份
def modulePaths = new HashSet<String>();
for(def filePath in getChangeFilePathSet()){
//忽略非前端模块的文件,比如 Jenkinsfile 等
if(filePath.startsWith(pathPrefix)){
//从超过模块前缀长度的下标开始,获取下一个/的位置。即分串位置
int index = filePath.indexOf('/', pathPrefix.length()+1)
//分串得到模块路径,比如 develop/@gc/test
def modulePath = filePath.substring(0, index)
println 'add module path: ' + modulePath
modulePaths.add(modulePath)
}
}
println '输出待发布模块列表:' + modulePaths
return modulePaths;
}

仅供抛砖引玉,抽取出来的方法本人将它们放到共享库中,写脚本就更清晰简短了。

还有什么问题

  • 首次构建会识别不到提交记录,可能会漏发一次
  • 切到未构建过的分支,也会漏发一次
  • 限于文章篇幅,未添加手动传参指定模块发布的功能

对于多分支首次检出漏发的问题,这是因为没有上一个可供参考的相同分支提交ID作参考,本身不是技术问题,预先将所有前端发版分支提交点内容,只要构建触发了,后续就不会再漏发了。

最后

希望对您能有所启发,如果您有更优雅的实现方式 或者 文中有错误,希望您能不吝赐教评论指出,感谢。

本文同步发布于博客园(东北小狐狸 https://www.cnblogs.com/hellxz/)与CSDN(东北小狐狸-Hellxz https://blog.csdn.net/u012586326)禁止转载。

Jenkins教程(八)实现 GitLab 触发 Jenkins 自动按模块发布前端的更多相关文章

  1. 持续集成之④:GitLab触发jenkins构建项目

    持续集成之④:GitLab触发jenkins构建项目 一:目的为在公司的测试环境当中一旦开发向gitlab仓库提交成功代码,gitlab通知jenkins进行构建项目.代码质量测试然后部署至测试环境, ...

  2. Gitlab触发jenkins并获取项目post参数

    jenkins -- Generic Webhook Trigger插件 此插件是git webhook的高阶应用,安装后会暴露出来一个公共API,GWT插件接收到 JSON 或 XML 的 HTTP ...

  3. gitlab与jenkins结合构建持续集成

    Jenkins是java编写,需要安装JDK,这里采用 yum 安装,对版本有需求的,可以到 oracle 官网下载 JDK. yum install -y java-1.8.0-openjdk 一. ...

  4. Gitlab自动触发Jenkins构建打包

    一.目的 在部门的测试环境中,开发人员一旦向gitlab仓库提交成功代码,gitlab就会自动触发jenkins构建项目.当然在构建后还可以添加项目部署或者自动化测试的脚本.这里只针对测试环境. 二. ...

  5. Gitlab源码库里代码提交后,如何触发jenkins自动构建?

    版本库里代码提交后,如何触发jenkins自动构建?这是一个面试题,感觉自己回答的并不好,因为并没有用过这个功能,之前公司实际项目用的是svn版本管理,一般都用立刻构建,和定时任务构建(不管代码是否有 ...

  6. jenkins+gitlab webhooks 实现自动触发打包

    说明:实现代码在gitlab上的提交后立马自动进行jenkins的job构建 安装插件: Gitlab Hook Plugin  Build Authorization Token Root Plug ...

  7. 配置GitLab Push 自动触发Jenkins构建

    配置GitLab Push 自动触发Jenkins构建 作者:尹正杰 版权声明:原创作品,谢绝转载!否则将追究法律责任. 本篇博客是对之前的笔记:https://www.cnblogs.com/yin ...

  8. Jenkins + GitLab 通过 Webhook 自动触发构建爬坑记录

    前言   在局域网搭建了一个Jenkins服务,用于自动构建和发布,在调通了构建程序之后,想使用内网的GitLab的Webhook功能触发代码推送事件,然后进行自动构建.后来发现在GitLab上做测试 ...

  9. GitLab 自动触发 Jenkins 构建

    GitLab 是当前应用非常广泛的 Git Hosting 工具,Jenkins 是非常牛逼的持续集成工具.尽管 GitLab 有内建的 GitLab CI,但它远没有 Jenkins 那么强大好用. ...

随机推荐

  1. 从源码解析Electron的安装为什么这么慢

    前言 Electron作为一款跨平台的桌面应用端解决方案已经风靡全球.作为开发者,我们几乎不用关心与操作系统的交互,直接通过Web前端技术与Electron提供的API就可以完成桌面应用端的开发. 然 ...

  2. Jave Hbase AP

    Hbase API 类和数据模型的对应关系 HBaseAdmin 类:org.apache.hadoop.hbase.client.HBaseAdmin 作用:提供了一个接口来管理 HBase 数据库 ...

  3. ☕【Java技术指南】「编译器专题」深入分析探究“静态编译器”(JAVA\IDEA\ECJ编译器)是否可以实现代码优化?

    技术分析 大家都知道Eclipse已经实现了自己的编译器,命名为 Eclipse编译器for Java (ECJ). ECJ 是 Eclipse Compiler for Java 的缩写,是 Jav ...

  4. Java课堂测试1第三阶段

    package sizeyunsuan;//import java.util.Scanner;//import java.util.Random;import java.util.*; public ...

  5. python json中的 dumps loads函数

    一.概念理解 1.json.dumps()和json.loads()是json格式处理函数(可以这么理解,json是字符串) (1)json.dumps()函数是将一个Python数据类型列表进行js ...

  6. 这样学BAT必面之软件设计原则,还不会就是我的问题

    学习设计原则是学习设计模式的基础.在实际开发过程中,并不要求所有代码都遵循设计原则,我们要考虑人力.时间.成本.质量,不能刻意追求完美,但要在适当的场景遵循设计原则,这体现的是一种平衡取舍,可以帮助我 ...

  7. [no code] Scrum Meeting 博客目录

    项目 内容 2020春季计算机学院软件工程(罗杰 任健) 2020春季计算机学院软件工程(罗杰 任健) 作业要求 Scrum Meeting博客目录 我们在这个课程的目标是 远程协同工作,采用最新技术 ...

  8. 【二食堂】Beta - Scrum Meeting 7

    Scrum Meeting 7 例会时间:5.19 18:30~18:50 进度情况 组员 当前进度 今日任务 李健 1. 文本区域的前后端对接完成,bug已经修复issue2. 自定义关系的添加与删 ...

  9. oo第二次博客-三次电梯调度的总结与反思

    本单元从电梯调度相关问题层层深入,带领我们学习并运用了了多线程相关的知识. 三次电梯调度依次为单电梯单容量.单电梯可携带.多电梯可携带. 一.我的设计 在第一次作业中,使用了最简单的FIFO调度方法. ...

  10. OO前三次作业思考(第一次OO——Blog)

    OO前三次作业总结 基于度量分析程序结构 由于三次作业较多,决定分析内容.功能最为复杂的第三次作业. 上图为第三次作业的类图.我使用了一个抽象类Factor,写了五个因子继承Factor,然后又单独开 ...