当前位置：首页 > article >正文

.gitlab-ci.yml文件参数

article 2024/11/14 22:01:30

天行健，君子以自强不息；地势坤，君子以厚德载物。

每个人都有惰性，但不断学习是好好生活的根本，共勉！

文章均为学习整理笔记，分享记录为主，如有错误请指正，共同学习进步。

一、参考文档

.gitlab-ci.yml文件中的job名称可自定义，但下面表中的参数不可以用作job名称
以下参数都是.gitlab-ci.yml文件中非必须的参数

关键字	描述
after_script	定义在每个job之后运行的命令，会在job执行结束后执行，可以是数组或多行字符串
before_script	定义在每个job之前运行的命令，会早于job执行，可以是数组或多行字符串
cache	定义一组文件列表，后续运行中使用
image	docker镜像使用
services	docker镜像使用
stages	定义构建阶段，阶段按定义顺序的优先级运行，同一阶段的job并行运行（实际上并行也是按照字母顺序），前一个阶段的job不成功结束，下一阶段的job不会开始，同一阶段的job在一个执行成功结束前下一个不会开始。若没有定义stages，job的stage则会默认定义为build，test，deploy。若job中未定义stage，则默认为test
variables	定义构建变量（可全局使用）
types	为stages别名，现已废除

本文中说的几个含义相同的词：
job、任务、作业是指一个意思
stage、阶段是指一个意思

以下为.gitlab-ci.yml文件的常用关键字：

关键字	描述
after_script	定义在每个job之后运行的命令，会在job执行结束后执行，可以是数组或多行字符串
allow_failure	允许job失败，不影响任务job的commit状态
before_script	定义在每个job之前运行的命令，会早于job执行，可以是数组或多行字符串
cache	定义一组文件列表，后续运行中使用
coverage	作业的代码覆盖率，正则表达式是唯一有效的值，‘/code coverage: \d+.\d+/’
dependencies	job依赖关系，可通过该参数实现相互传递artifacts
environment	任务部署的环境变量
except	指定哪些分支不触发job，即该任务在指定的分支上不执行
image	docker镜像使用
include	允许job加载其他的yaml文件
only	指定哪些分支会触发任务，可定义多个
pages	上传gitlab pages的结果
parallel	指定并行运行的job实例
retry	指定job失败时可自动执行多少次
script	唯一一个不许参数，需要执行的脚本代码
services	docker镜像使用
stages	定义流水线所有阶段，阶段按定义顺序的优先级运行
stage	job所处阶段，默认为test
tags	定义一列tags，指定选择哪个runner运行该任务（前提是runner有设置tag）
trigger	指定下游流水线的触发器
types	为stages别名，现已废除
variables	定义构建变量（定义在job外则可全局使用，定义在job下则仅作用于job内）
when	指定何时运行job，默认为on_success即所有任务都完成后运行当前任务

参数配置请注意以下几点：

在variables中定义的变量，可以在后面使用${变量名}来引用定义的变量
如定义变量JAVA_HOME = /usr/lib.jvm/jdk-1.8.0.392
后续引用JAVA_HOME的值，如${JAVA_HOME}

这里的job是指作业的job名称，每个job部分都有一个job名称，如果想跳过该job的部分不执行，可以在job名称前使用英文字符.来实现，如job名称为job-build，那么可以用.job-build来实现跳过该部分任务

script命令正常不需要单引号或双引号包裹，但当命令中有特殊字符时，需要使用单引号或双引号包裹
如英文半角格式下的:{}[],&*#?|-<>=!

only和except中可使用如下特殊关键字

关键字	描述
api	一个pipelines被另一个pipelines触发（非触发器api）
branches	常用，当一个分支被推送上来时触发
chats	当使用gitlab chatops创建作业时触发
external	当使用gitlab以外的外部CI功能（如jenkins）时触发
merge_requests	当merge请求创建或跟新时触发
pipelines	对于多项目触发器，当使用CI_JOB_TOKEN，并使用gitlab的api创建多个pipelines时触发
pushes	当用户执行git push时触发
schedules	对于预定的pipelines计划，自动触发
tags	当一个打了tag标记的release被提交时触发
triggers	使用触发器token创建pipelines时触发
web	在gitlab的web界面中的pipelines菜单页，使用run pipeline按钮时触发

only和except还支持高级策略，四个关键字可用：refs、variables、changes、kubernetes

refs使用策略如下：

其中正则和特殊字符的使用如下：

job_name:
  only:
    - /^dev-.*$/
  except:
    - tags

正则表达式需要用//包起来，且上述正则表达式表示匹配以dev开头的分支进行执行job

when的值可选范围为：

on_success 默认值，当前面的stage所有任务成功结束（或执行失败但是配置了allow_failure:true）时才执行当前任务
on_failure 当前面任一stage中的任一任务运行失败后执行当前任务
always 不管前面stage任务状态如何都会执行执行当前任务
delayed 延迟当前任务的执行，指定延迟时间，配合start_in一起用，start_in的值小于等于1小时，（示例10 seconds，30minutes，1 hour），前面的任务结束，计时开始
manual 在Gitlab的UI界面手动触发执行当前任务

感谢阅读，祝君暴富！