如何编写GitLab-CI配置文件

创建文件

在根目录新建.gitlab-ci.yml文件.

该文件与项目其他文件一样, 同样受到版本控制, 所以可以在不同的分支下, 配置不同的持续集成脚本

YAML语法

配置文件遵循YAML语法, 关于该语法的内容, 自行搜索

参考 YAML 语言教程

关键词

根主要关键词一览

关键词含义可选备注
image声明使用的Docker镜像为空时使用默认镜像该镜像应当满足脚本执行的环境依赖
servicesDocker镜像使用的服务, 通过链接的方式来调用所需服务可空常用于链接数据库
stages定义构建阶段为空时, 单纯定义jobs项目的构建分为多个阶段, 例如: 安装依赖/准备, 编译, 测试, 发布等, 同时每个阶段包含若干任务
before_script定义每个job之前执行的脚本可空每个job启动时会先执行该脚本
after_script定义每个job之后执行的脚本可空同上
variables定义变量可空同上
cache定义与后续job之间应缓存的文件可空同上

Demo:

image: aipline
services:
    - mysql
    - redis
stages:
    - build
    - test
    - deploy
before_script:
    - bundle install  
after_script:
    - rm secrets
cache:
    paths:
    - binaries/
    - .config

Jobs中的关键词

jobs中存在一些与根中相同的关键词, 这些一旦定义, 则会向前覆盖, 即根中定义的则不会在该job执行

job 这里译为任务

关键词含义可选备注
image声明任务使用的Docker镜像为空时使用根中的定义该镜像应当满足脚本执行的环境依赖
services任务中Docker镜像使用的服务, 通过链接的方式来调用所需服务可空常用于链接数据库
stage所属构建阶段为空时则不使用stages一个任务属于一个构建阶段
before_script定义每个job之前执行的脚本可选如果在job中定义则会覆盖根中的内容
script定义每个job执行的脚本必须
after_script定义每个job之后执行的脚本可选同上
variables定义任务中使用的变量可选同上
cache定义与后续job之间应缓存的文件可选同上
only指定应用的Git分支可选可以是分支名称, 可用正则匹配分支, 也可是tags来指定打过标签的分支
except排除应用的Git分支可选同上
tags指定执行的GitLab-Runners可选通过匹配Runners的标签选定
allow_failure允许失败默认为false如果允许失败, 本次任务不会影响整个构建的结果
when定义合适执行任务默认为alwayson_success, on_failure, always or manual可选
dependencies定义合任务所需要的工件可空需要首先定义工件
artifacts定义工件可空工件中指定的目录会在任务执行成功后压缩传到GitLab, 后面需要该工件的任务执行时, 再自行下载解压
environment定义环境可空在部署任务中, 定义该任务所属的环境

Demo:

installing-dependencies:
    script:
        - composer install --prefer-dist --optimize-autoloader -n --no-interaction -v --no-suggest
        - composer dump-autoload --optimize
    artifacts:
        name: "vendor"
        untracked: true
        expire_in: 60 mins
        paths:
            - vendor/    
docker-build-image:    
    stage: test
    only:
        - master
    except:
        - develop
    tags:
        - ruby
        - postgres
    allow_failure: true
    dependencies:
        - installing-dependencies
    script:        
        - docker build -t registry.com/mops/image:latest .
        - docker push registry.com/mops/image:latest 
         

注意:

  1. jobs的名称不能重名
  2. 同一阶段中的任务, 是并行执行的
  3. 上一阶段所有任务执行完后, 才会进入下一阶段
  4. 定义工件时, 务必定义工件的过期时间, 否则工件会一直寸在GitLab上, 占用空间
  5. 如果需要在任务中传递文件, 优先选择使用 dependencies (结合artifacts)

验证配置文件合法性

在GitLab中, 打开 /ci/lint网址, 将配置文件粘贴在些, 进行验证

相关文档

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

少湖说

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值