GitLab CI/CD 的执行流程

介绍

GitLab CI/CD 是一个简洁好用的的持续集成/持续交付的框架。通过为你的项目配置一个或者多个 GitLab Runner,然后撰写一个 .gitlab-ci.yml,你就可以很方便地利用 GitLab CI/CD 来为你的项目引入持续集成/交付的功能。

执行流程

Stage

GitLab CI/CD 的执行过程中首先驱动的是 Stage。

CI 中 Stage 的执行

每个 GitLab CI/CD 都必须包含至少一个 Stage。多个 Stage 是按照顺序执行的。如果其中任何一个 Stage 失败,则后续的 Stage 不会被执行,整个 CI 过程被认为失败。

以图中所示为例,整个 CI 环节包含三个 Stage:buildtest
deploy

  • build 被首先执行。如果发生错误,本次 CI 立刻失败;
  • testbuild 成功执行完毕后执行。如果发生错误,本次 CI 立刻失败;
  • deploytest 成功执行完毕后执行。如果发生错误,本次 CI 失败。

Stage 在 .gitlab-ci.yml 中通过如下的方式定义:

stages:
  - build
  - test
  - deploy

如果文件中没有定义 stages,那么则默认包含 buildtestdeploy 三个 stage。

Stage 中并不能直接配置任何具体的执行逻辑,具体的执行逻辑应该在 Job 中配置。

Job

Stage 中 Job 的执行

Job 可以被关联到一个 Stage。当一个 Stage 执行的时候,与其关联的所有 Job 都会被执行。需要注意的是,Job 在设计上是可并行执行的。这样的好处是可以利用多个 Runner 来加速 CI/CD 的流程。

因此,如果 Job 之间有依赖关系的话,需要通过关联到不同的 Stage 来实现。

Job 在 .gitlab-ci.yml 中通过如下的方式来和 Stage 关联:

job_build_module_A:
  stage: build

如果一个 Job 没有显式地关联某个 Stage,则会被默认关联到 test Stage。

Job 的执行

Job 包含了真正的执行逻辑,例如调用 mvn 或者 gcc 等命令。

job_build_module_A:
  script:
    - cd module_A
    - mvn clean compile

公共配置

随着项目越来越大,Job 越来越多,Job 中包含的重复逻辑可能会让配置文件臃肿不堪。.gitlab-ci.yml 中提供了 before_scriptafter_script 两个全局配置项。这两个配置项在所有 Job 的 script 执行前和执行后调用。

例如:

job_build_module_A:
  script:
    - export MAVEN_OPTS="-Xmx256m"
    - cd module_A
    - mvn clean compile

...

job_build_module_Z:
  script:
    - export MAVEN_OPTS="-Xmx256m"
    - cd module_Z
    - mvn clean compile

这其中 export MAVEN_OPTS="-Xmx256m" 显然是可以抽取公用的部分,在 before_script 的帮助下,配置文件可以优化成:

before_script:
  - export MAVEN_OPTS="-Xmx256m"

job_build_module_A:
  script:
    - cd module_A
    - mvn clean compile

...

job_build_module_Z:
  script:
    - cd module_Z
    - mvn clean compile

after_script 也可以起到类似的作用,不过是在每个 Job 执行完毕以后被调用。

公共数据 - Cache

Job 的执行过程中往往会产生一些数据,默认情况下 GitLab Runner 会保存 Job 生成的这些数据,然后在下一个 Job 执行之前(甚至不局限于当次 CI/CD)将这些数据恢复。这样即便是不同的 Job 运行在不同的 Runner 上,它也能看到彼此生成的数据。

不过这些行为可能会带来意料之外的问题,比如说上一次 CI/CD 执行的是 master 分支的 build,下一次 CI/CD 执行的却是 devel 分支的 build,而 build 脚本偏偏是增量执行的,那么有可能导致第二次 build 的过程错误地引用了 master 编译生成的中间结果。

这个情况下,我们需要配置 cache.key

cache:
  key: "$CI_COMMIT_REF_NAME"

这个配置的意思是:所有的 Job 在恢复 cache 的时候,是根据当前的分支名称去选择对应的 cache。换句话说,前面例子中的两次 build 会选中不同的 cache,数据自然就隔离开了。

当然,上面的隔离粒度是分支级别的,你还可以配置成 分支+Job 级别的:

cache:
  key: "$CI_JOB_NAME-$CI_COMMIT_REF_NAME"

上面两个例子中的 CI_COMMIT_REF_NAMECI_JOB_NAME 是 GitLab CI/CD 的预定义变量。除了它们以外,还有许多预定义变量可以供我们选择,详情可以参阅《GitLab CI/CD Variables: Predefined variables》

Job 的执行总览

在了解了 Job 配置的 scriptbefore_scriptafter_scriptcache 以后,我们便可以将整个 Job 的执行流程用一张图概括下来了:

Job 执行流程

总结

通过上面的介绍,我们可以了解到:

  1. GitLab CI/CD 是通过 GitLab Runner 来执行的
  2. GitLab CI/CD 将按照 Stage 定义的顺序来执行,任何一个 Stage 失败,整个 CI/CD 将失败
  3. 每一个 Stage 可以被若干个 Job 关联。Stage 在执行的时候,关联到这个 Stage 的所有 Job 都将被执行,不过不同的 Job 可能是并行执行的。
  4. 每个 Job 在执行的时候,会先按照缓存策略加载缓存数据,然后按照顺序依次运行 before_scriptscriptafter_script 中配置的脚本,运行完毕以后,会将生成的数据保存到缓存中。

参阅

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,386评论 6 479
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,939评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,851评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,953评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,971评论 5 369
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,784评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,126评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,765评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,148评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,744评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,858评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,479评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,080评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,053评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,278评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,245评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,590评论 2 343

推荐阅读更多精彩内容