极狐 GitLab 冷知识：在 Gitlab CI Pipeline 中进行 Git Push 操作
前言
在日常工作中，经常会遇到这样一种场景：需要在 GItLab CI Job 中进行 Git Push 操作，将修改或构建好的代码推送到远端 Git 代码仓库当中。这是一个十分常见操作，本篇文章将会提供一个最简单且实用的方法来实现这个场景，希望对您有所帮助。
预备知识
在开始之前，有一些预备知识需要介绍，这些知识也会帮您进一步掌握 GItLab CI 的使用技巧。
incloud 关键字
使用 include 在 CI/CD 配置中 import 外部 YAML 文件。您可以将一个长的 .gitlab-ci.yml 文件拆分为多个文件以提高可读性，或减少同一配置在多个位置的重复。
include 目前支持 4 种导入模式：
local：导入位于同一仓库中的文件file：导入同一实例上另一个私有仓库的文件remote：使用完整 URL 导入远程实例中文件template：导入 GItLab 提供的 CI Template
使用 include 关键字可以将 git push 相关操作与 .gitlab-ci.yml 文件进行解耦，方便维护也更易于阅读。
extends 关键字
使用 extends 来重用配置，也是将 git push 相关操作插入具体 Job 的方法。它是 YAML 锚点 的替代方案，并且更加灵活和可读。
before_script 与 after_script
使用 before_script 可以定义一系列命令，这些命令应该在每个 Job 的 script 命令之前，但在 artifacts 恢复之后运行。
使用 after_script 定义在每个作业之后运行一系列命令，需要注意的是，即使是失败的 Job 也会运行这一系列命令。
我们可以非常方便的在 before_script 定义 Git 操作的预备逻辑，如： clone 代码、配置 email/username 等；而在 after_script 中我们会定义 Git 的 commit 以及 push 操作。
CI 预定义变量
预定义变量是每个 GitLab CI/CD 流水线中都有的 CI/CD 变量，使用这些变量可以快速获得该运行 Job 的一些常用信息，同时也应该尽量避免覆盖这些变量，否则可能导致 Pipeline 的运行出现意外。
本文我们要用到的 CI 预定义变量有：
更多的预定义变量，见官方文档。
Step by step
有了上面这些知识储备，我们就可以开始动手实践了。
创建访问令牌
要完成 Git Push 操作，首先我们需要有一个具有相应权限的访问令牌，如果您使用的是极狐 GItLab SaaS 平台，可以直接访问 https://jihulab.com/-/profile/personal_access_tokens 来进行创建。
创建个人访问令牌时，需要勾选以下范围：
read_repositorywrite_repository
请保管好您的个人访问令牌，推荐为每个令牌设置到期时间，如果令牌泄露，请尽快到个人访问令牌页面撤销该令牌并重新生成新的令牌。
设置变量
生成好个人访问令牌，就可以在 设置->CI/CD->变量 中插入相应 KV 了，插入的 KV 会作为环境变量注入到 GItLab CI Pipeline 中。这里需要插入的变量有：
创建 CI Template
在 .gitlab/ci/ 目录中新建 git-push.yaml 文件（当然您也可以在其他位置创建）。
细心的读者可能会发现，上面这个 git-push.yaml 中并没有 script 关键字，也就是说，这个 Job 是不能单独运行的，您需要将其 incloud 到您的 .gitlab-ci.yml 并且 extends 到相关 Job，效果如下：
此处的 ${CI_COMMIT_SHA} 就是我们在 before_script 中 clone 的仓库目录，理论上可以使用任何名称来代替，这里使用 ${CI_COMMIT_SHA} 是为了确保这个目录名称唯一不会和其他目录名称重复。
结语
GItLab CI 一直在努力平衡易用性和灵活性，通过多种关键字和预定义变量来让用户更好的使用和构建 Pipeline，同时也不会过多的限制用户的发挥空间，上面这段逻辑，完全可以使用其他 shell 或 Python、JS、Go 等编程语言来实现其功能。本文也只是一个引子，通过 Git Push 这个场景来引出 include 、 before_script 与 after_script 以及预定义变量的使用，如果您有更好的方式，欢迎留言。
版权声明: 本文为 InfoQ 作者【郭旭东】的原创文章。
原文链接:【http://xie.infoq.cn/article/021bdb4cea9a6f2e448c168b2】。文章转载请联系作者。
服务可靠无异常，节点稳定不宕机 2018.09.08 加入
柴猫双全的码农
评论