术语概念
构建计划( Job ):作为持续集成流程的基本单元,每个Job都代表一个步骤,可配置代码源、构建流程、触发规则、环境变量、通知提醒等信息。
快速上手
图形化配置:具体参考官方文档,易用性高
Jenkinfile灵活配置:提前写好Jenkinsfile放到项目最外层(与.git同级),在Coding选择[配置来源] -> [使用代码库的{你编写的Jenkinfile名称}]
流水线入门
下面指令按照层级进行介绍,每个子级必须包括在父级的大括号里面
- pipeline:声明一条流水线,必须编写并包裹在最外层
- agent:代理,指定执行流水线的容器
- docker: 在Docker内执行流水线
- image <镜像名称>:指定Docker镜像
- args <参数>:指定运行Docker时的参数
- dockerfile:先构建Docker镜像再在容器中执行流水线
- filename <文件名>:指定dockerfile的文件名,如果不指定则默认’dockerfile’
- dir <文件夹>:指定构建镜像的路径(影响dockerfile获取文件)
- docker: 在Docker内执行流水线
- stages:阶段集合(据作者测试没有实际作用,但必须声明否则报错)
- stage(name):阶段,name指定阶段名称。
- when:条件,指定执行阶段的条件
- branch <分支>:判断当前构建的代码分支是否与指定的相同
- steps:步骤,包含一条或多条命令,按顺序执行
- sh <shell命令>:执行命令,命令要用单引号包裹
- junit <Junit配置路径>:调用Jenkins的测试插件(Junit配置)
- script:
- archiveArtifacts: 收集构建产物,指定的文件会在构建结束后展示在[构建产物]中
- dir(path: <目录路径>):跳转至该目录再执行步骤,(步骤只执行dir内部包含的)
- parallel: 并行,包含多个阶段,所包含阶段会并行执行
- when:条件,指定执行阶段的条件
- stage(name):阶段,name指定阶段名称。
- post:当每个流水线或阶段结束后都会执行一次
- <条件>:always(成功或失败都执行),changed(状态与前一次不同时执行),failure(失败时执行),success(成功时执行)
- environment:全局变量,在任一步骤中通过变量名进行引用。也可以声明在阶段内部作为局部变量使用。
- 变量名 = 变量值
- agent:代理,指定执行流水线的容器
例子:
pipeline { // 声明流水线
agent any // 设置代理
stages { // 阶段集合
stage('检出') { // 阶段1
steps { // 步骤
checkout([ // 从git仓库读取(这段基本不修改,环境变量会由Coding注入)
$class: 'GitSCM', branches: [[name: env.GIT_BUILD_REF]],
userRemoteConfigs: [[
url: env.GIT_REPO_URL,
credentialsId: env.CREDENTIALS_ID
]]
])
}
}
stage('构建') { // 阶段2
steps { //步骤
sh 'mvn install -Dmaven.test.skip -s ./setting.xml' //执行Shell命令
}
}
stage('发布') {
steps {
sh 'mvn deploy -s ./setting.xml‘
}
}
}
}
实战
总体流程:创建制品库 =》 配置maven =》 配置项目Pom =》 编写jenkinsfile =》 创建Job =》 上传代码,触发构建
在Coding创建制品库:
2. 创建setting文件:
这里使用Coding访问令牌生成配置,供构建使用(放在代码根目录下,不是更新本地的maven配置)
(用于配置连接制品库的账号密码,maven deploy时要先登陆制品库)
得到有<servers>配置的setting.xml文件
依赖制品库内的制品时添加该配置
查看Coding制品库指引,并将<profiles>添加到setting文件
(这里添加这个配置是为了构建时能连接制品库仓库,并拉取里面得制品依赖)
最后setting文件如下:
<settings>
<servers>
<server>
<!--仓库 ID-->
<id>id</id>
<username>username</username>
<password>password</password>
</server>
</servers>
<!--如果构建依赖制品库内的制品,则需要添加一下配置(如何获取配置看回上面)-->
<profiles>
<profile>
<id>Repository Proxy</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<repositories>
<repository>
<id>制品库id</id>
<name>maven</name>
<url>制品库地址</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
</repositories>
</profile>
</profiles>
</settings>
- 配置pom文件:在项目pom.xml添加一下配置
具体配置可以在Coding制品库的指引中直接获取
<distributionManagement>
<repository>
<!--必须与 settings.xml 的 id 一致-->
<id>制品库id</id>
<name>maven</name>
<url>制品库地址</url>
</repository>
<!--有快照需求的可以添加,id和url和上面相同-->
<snapshotRepository>
<id>id</id>
<name>maven</name>
<url>制品库地址</url>
</snapshotRepository>
</distributionManagement>
ps:我直接将这个配置在了parent项目,<distributionManagement>是可以被继承的
- 编写Jenkinsfile文件:
setting.xml我是放在和Jenkinsfile同目录,所以我就直接./setting.xml引用了;
代理选any就可以,Coding的Jenkins环境自带了maven;
无论是install或者deploy都要添加 -s setting.xml,不然会出现找不到制品库的错误;
pipeline {
agent any
stages {
stage('检出') {
steps {
checkout([
$class: 'GitSCM', branches: [[name: env.GIT_BUILD_REF]],
userRemoteConfigs: [[
url: env.GIT_REPO_URL,
credentialsId: env.CREDENTIALS_ID
]]
])
}
}
stage('构建') {
steps {
sh 'mvn install -Dmaven.test.skip -s ./setting.xml'
}
}
stage('发布') {
steps {
sh 'mvn deploy -s ./setting.xml'
}
}
}
}
- 创建Job:
注意Jenkinsfile也需要放在代码根目录
6. 更新代码,执行构建
最后我的项目目录是这样的
构建镜像和持续部署
==