基于gitlab和jenkins搭建CI

发表于 | 分类于

参考文章：

持续集成是什么？
gitlab push代码通过webhooks自动触发jenkins构建设置

CI（Continuous integration） 持续化集成，持续集成是什么？请参考文章持续集成是什么？

就是定时将代码提交然后走一系列验证最终保证代码健壮的思路

以使用cocoapod管理的iOS库来说,一个iOS库从提交代码到验证的流程有一下几步：

  1. pod lib lint 验证podspec文件
  2. unit_test ui_test 跑单元测试
  3. package打包framework
  4. publish发布升级版本

现在我们以上为例简单介绍两种iOS自动化ci配置流程之所以说两种只是依托平台不同

  1. 基于gitlab
  2. 基于jenkins

一、基于gitlab搭建CI

从gitlab 8.0开始，就已经集成ci了，整体的工作流程如下：

  1. 当git commit之后首先会判断当前项目是否开启CI
  2. 开启后会检查本地是否有.gitlab-ci.yml文件
  3. 读取.gitlab-ci.yml文件的配置核对触发条件
  4. 触发条件正确会调用配置的ci-runner按照.gitlab-ci.yml配置执行相应的task

开启CI

  • Setting->General->Permissions->Pipelines

编辑gitlab-ci.yml

gitlab-runner通过gitlab-ci.yml文件管理工程任务。配置文档
简单介绍下几个关键字：

  • script执行的shell脚本

  • before_script and after_script

    • before_script声明的配置会在所有job执行之前
    • after_script声明的配置会在所有job执行之后

  • stages定义了整个工程的不同阶段

    • 每一个job都会有对应的stage
    • 相同stage的job是并行的

  • only and except是描述限制任务执行的规则，也就是触发条件，两者可以同时存在，支持正则Ruby regexp syntax).

    • tags推送tag触发
    • branchs指定分支触发

  • tags指定对应的ci-runner

  • when指定当前job的触发时机

下面是项目中的配置：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
before_script:
  # https://gitlab.com/gitlab-org/gitlab-ce/issues/14983
  # shared runner 会出现，special runner只会报warning
  - export LANG=en_US.UTF-8
  - export LANGUAGE=en_US:en
  - export LC_ALL=en_US.UTF-8
after_script:
  - rm -fr xxxxxx
stages:
  - check
  - lint
  - package
  - publish
  - report
  - cleanup
component_check:
  stage: check
  script: 
    - xxxx.rb
  only:
    - master
    - /^release.*$/
    - tags
    - CI
  tags:
    - iOS
lib_lint:
  stage: lint
  only:
    - master
    - /^release.*$/
    # - tags
    - CI
  retry: 2
  script: 
    - xxxxxx.sh
  tags:
    - iOS
package_framework:
  stage: package 
  only:
    - tags
  script:
    - xxxxxx.sh
  tags:
    - iOS
publish_pod:
  stage: publish
  only:
    - tags
  retry: 2
  script:
    - xxxxxx.sh
  tags:
    - iOS
  # allow_failure: true
report_to_director:
  stage: report
  script:
    - xxxxxx.sh
  only:
    - master
    - tags
  when: on_failure
  tags:
    - iOS

配置CI-Runner参考文档

  • 安装ci-runner
1
2
3
sudo curl --output /usr/local/bin/gitlab-runner https://gitlab-runner-downloads.s3.amazonaws.com/latest/binaries/gitlab-runner-darwin-amd64
sudo chmod +x /usr/local/bin/gitlab-runner
  • 注册runner
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
sudo gitlab-runner register
Please enter the gitlab-ci coordinator URL (e.g. https://gitlab.com )
xxxxx
Please enter the gitlab-ci token for this runner
xxxxx
Please enter the gitlab-ci description for this runner
xxxxx
Please enter the gitlab-ci tags for this runner (comma separated):
ios,ios-member
Please enter the executor: ssh, docker+machine, docker-ssh+machine, kubernetes, docker, parallels, virtualbox, docker-ssh, shell:
shell
  • 安装启动
1
2
3
cd ~
gitlab-runner install
gitlab-runner start

启动完成会在gitlab页面看到当前活跃的runner

到现在基本简单流程已经配置完毕，最核心的还是gitlabci.yml的脚本实现，最终的执行效果可以在gitlab上看到

二、基于jenkins搭建CI

MAC 安装Jenkins

对于jenkins来说CI执行的流程步骤由Jenkinsfile控制，Jenkinsfile支持两种语法声明式 (在流水线 2.5引入)和脚本化流水线，详细看这里

这里只是简单介绍构建pipeline流程，具体实现根据需求自行处理

创建pipeline有三种方式，这里介绍第三种：手动编写一个 Jenkinsfile 文件, 然后提交到项目的源代码控制仓库中
jenkins安装好新建任务选择pipeline任务

先看pipeline选项看我们选择Pipeline script from SCM

配置完成之后只需要在项目创建Jenkinsfile就好了，下面简单介绍下pipeline语法，编写基础的Jenkinsfile

声明式流水线：所有有效的声明式流水线必须包含在一个 pipeline 块中

1
2
3
pipeline {
    /* insert Declarative Pipeline here */
}

列举常用支持的字段：

key value desc
agent any 任何可用节点
none 当在 pipeline 块的顶部没有全局代理， 该参数将会被分配到整个流水线的运行中并且每个 stage部分都需要包含他自己的agent 部分
label 指定标签的节点执行（mac安装jenkins文章里添加的多节点对应的标签）
post always 任何时候都允许在 post 部分运行该步骤
changed 当前运行状态与之前不同时允许在 post 部分运行该步骤
failure 失败时允许在 post 部分运行该步骤
success 成功时允许在 post 部分运行该步骤
unstable unstable 时允许在 post 部分运行该步骤
aborted aborted 时允许在 post 部分运行该步骤
stages 包含一系列一个或多个 stage 指令
stage stage 指令在 stages 部分进行，应该包含一个 实际上, 流水巷所做的所有实际工作都将封装进一个或多个stage 指令中
steps steps 部分在给定的stage 指令中执行的定义了一系列的一个或多个steps。

下面看简单的jenkinsfile：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
pipeline {
    agent any
  	stages {
        stage('Build') {
            steps {
                echo 'Building....'
                sh 'sh test.sh'
            }
        }
        stage('Test') {
            steps {
                echo 'Testing..'
            }
        }
        stage('Deploy') {
            steps {
                echo 'Deploying....'
            }
        }
        post { 
        		always { 
           		 echo 'I will always say Hello again!'
	       	}
	    }
  	}
}

其中调用shell脚本的方法sh 'shell语句'

配置完jenkinsfile之后便可以构建了

我们可以通过git 服务器提供的webhook来实现自动触发：




目前我们使用gitlab来做CI,jenkins用来打包使用，具体jenkins的配置可以详细参照jenkins用户手册