Gitlab CI/CD 入门教程

前言

开发人员常常提到的 CI/CD 是什么?

  • 是用于集成测试的工具,每次提交代码后自动检测、构建和进行单元测试的过程。这一整条流水线式的测试流程我们称之为 pipeline。

入门教程

如何使用 CI/CD?

  • 首先需要确保有可用的 runner(如何确保呢?请看 CI/CD 入门),来运行下文提到的各种任务。
  • 在仓库的根目录下创建并编写一个 .gitlab-ci.yaml 文件,记录需要执行的各种指令,比如进行规范检查(例如PEP8)、自动打包、自动部署等。该遵循 yaml 文件的语法,可以使用 gitlab 自带的 CI lint 检查。

使用技巧

在编写 .gitlab-ci.yaml 文件的时候,有很多关键字,本文列举了一些常用&重要的关键字。

  • stages 关键字:定义了pipeline中各任务的执行顺序。 需要注意以下几点:

    • 如果两个任务对应的stage名相同,则这两个任务会并行运行

    • 一个stage成功执行完了,才能执行下一个stage(如果失败了,下一个stage将不会执行,如果想要修改该特性,可以使用when关键字,见下文)

    • 如果想要控制某一个stage在最开始,或者最后执行,可以使用.pre.post 关键字

    • 举例( 下面样例的执行顺序是: build-job1 & build-job2并行执行 -> test1 -> deploy。)

      stages:
      - build
      - test
      - deploy

      build-job1:
      stage: build
      script: echo "build-job1"

      build-job2:
      stage: build
      script: echo "build-job2"

      test1:
      stage: test
      script: echo "test"

      deploy1:
      stage: deploy
      script: echo "deploy"
      ...

  • only/except 关键字:控制任务的触发条件。

    • only关键字的默认策略是['branches', 'tags'],即你提交了一个分支或者打了标签,就会触发;except 和 only 语义相反。

    • 策略的分类:

      • branches: 当你的Git Refs对应的是一个分支时触发
      • tags: 当你的Git Refs对应的是一个标签时触发
      • pushes: 当你使用git push时触发
      • merge_requests: 当你创建或者更新一个merge_requests时触发
      • ...
  • tags 关键字:指定使用哪个Runner(哪个机器)去执行任务,注意与上文only关键字的tags进行区分

  • cache关键字:指定了需要缓存的文件夹或者文件,目的是为了加快执行速度

  • artifacts关键字:和cache类似,也可以缓存文件或文件夹,不同的是,这些文件可以在Gitlab的UI界面中下载,一般可用来存储Android打包生成的apk。

  • allow_failure关键字:允许任务失败,任务失败将不会影响pipeline失败。

  • dependencies关键字:定义了任务的依赖关系,比如依赖其他的项目、库、工具、任务等。

  • variables关键字:定义局部变量(只在当前的任务中生效)

  • when关键字:可以手动修改stage原有的执行规则。一共有五个值:

    • on_success:只有前面stages的所有工作成功时才执行,这是默认值。
    • on_failure:当前面stages中任意一个jobs失败后执行
    • always:无论前面stages中jobs状态如何都执行
    • manual:手动执行
    • delayed:延迟执行
  • 更多关键字参考:https://docs.gitlab.cn/jh/ci/yaml/

完整样例

来一个完整的 .gitlab-ci.yml 例子:

  stages:  # 定义了两个stage,先 build 后 test
    - build
    - test

  cache: # 定义 cache 缓存文件夹路径
    paths:
      - cache_dir/

  variables:  # 定义了全局变量,所有任务中的NVIDIA_GROUP变量都是 xxx
    NVIDIA_GROUP: xxx

  build-job:
    stage: build
    variables:
      DOCKER_IMAGE: $REGISTRY/$IMAGE_ID  # 专属于 build-job 的局部变量
    only:  # 当前任务只会在打 tag 和master 分支有提交时才会触发
      - tags
      - master
    tags:  # 指定当前任务在 machine1 这台机器上执行
      - machine1
    script: # 当前任务的执行脚本
      - echo "build-job is runing"
    cache:  # 当前任务的缓存文件夹
      - binaries/
    artifacts:
      paths:
        - html_doc/
    allow_failure: true  # 允许当前任务失败

  test-job:
    stage: test
    dependencies:  # 当前任务依赖 build-job 的执行结果
      - build-job
    only:  # 当前任务只在 master 分支有所提交的时候才会触发
      - master
    script:
      - echo "test-job is running"

参考资料:

相关推荐
Kkooe7 小时前
GitLab|GitLab报错:Restoring PostgreSQL database gitlabhq_production...
gitlab
安静读书18 小时前
持续集成与持续部署:CI/CD简介
运维·ci/cd
小柒xq1 天前
使用docker compose安装部署gitlab
docker·容器·gitlab
桥豆麻袋93931 天前
Sourcetree登录GitLab账号
linux·服务器·gitlab
安静读书2 天前
持续集成与持续部署:CI/CD实现教程
ci/cd
活宝小娜2 天前
标题gitLab如何打标签
gitlab
AliCloudROS3 天前
2分钟在阿里云ECS控制台部署个人应用(图文示例)
阿里云·ci/cd·持续部署
天草二十六_简村人4 天前
jenkins用户在执行scp的时候如何做免密登录
运维·ci/cd·node.js·jenkins·php·devops
骑士9991114 天前
centos7 安装gitlab
gitlab
binqian4 天前
【gitlab】gitlabrunner部署
gitlab