最近都好忙，需求太多了，干不完，加上最近作息时间的调整，都没时间写博客了，趁着这两天稍微有点时间，想撸一发；

其实在写的博客有好几篇，但都是陆陆续续的，本来想继续写之前的，突然想起半个月前，同学提出，能不能在开发提 tag 时自动打包？

之前发布过一篇项目流程规范，目前的项目都在遵守这个规范，而研发每次有改动过代码的时候，都会提测，而提测就相当于提 tag，这个tag的概念不说了，就是基于当前产品分支重新拉的分支，tag 的格式如下图；

而测试拿到这个 tag 后，就需要去到 jenkins 打包，要输入一堆参数，然后等待打包结果；

有时候，研发勤奋点，一天提多次 tag，测试就需要多次去打包，测试同学觉得太麻烦了，因此就提出一个想法，能不能在开发提 tag 时自动打包？

能，必须能，没有做不到的事情；

分解

做事之前，要先想想要做什么？

• 搭建 jenkins 环境及安装对应插件
• jenkins 打通到 gitlab
• 触发任务

想了下，大致就这 3 步，那就来一起做吧；

搭建 jenkins

为了测试，jb 就用了自己的阿里云服务器从头开始搭建一遍，具体搭建过程不说明，之前写的一篇文章有提及到，直接对照操作就好；

安装 jenkins

步骤	说明
安装 Java	sudo yum install java
安装 jenkins	yum install jenkins
启动 jenkins	service jenkins start
安装插件	完

注意

修改 jenkins 端口
jenkins 默认端口是 8080，可能会跟别的软件冲突，因此建议修改下端口；

进入 jenkins 配置文件

vi /etc/sysconfig/jenkins

打开后，找到JENKINS_USER跟JENKINS_PORT这两项进行修改即可；

修改成 root 跟具体端口保存退出即可；

这时候，直接输入主机 IP+ 刚设置的端口就好啦；

阿里云开放端口权限
上面访问 ip+ 端口，有可能打不开链接，因为阿里云对端口做了限制，因此需要开放端口；

登录阿里云，首页右上找到控制台；

找到云服务器 ECS

点击实例，找到该实例的安装组配置

点击规则说明，新增即可；

如果是按照上面的文档来，安装完插件，创建完用户后，就应该进入到首页，会显示如下内容，至此，jenkins 环境搭建就完啦~！

对了，jenkins 的目录在这里：

/var/lib/jenkins

jenkins 打通到 gitlab

公司的代码仓库是用 gitlab，因某种原因，就开放公网啦，那 jb 就在 gitlab 新建一个 jbtest 项目；

如果有小伙伴说，没有 gitlab 怎么办？没关系，可以用 github 代替，至于 github 相关的配置，可以查看该文章：git 介绍及 GitHub 配置教程

jenkins 安装 gitlab

既然确定是要用 jenkins+gitlab，那就先在 jenkins 上安装下 gitlab 插件吧；

点击 jenkins 首页，有个系统管理按钮；

点击后右侧会显示内容，下滑，点击插件管理；

进入到插件管理界面，就看到 updates 等 4 个栏目，那点击Available，右侧输入gitlab，然后找到GitLab跟GitLab Hook，勾选，点击底部的 install 即可；

test 项目有了，gitlab 的插件也安装了，那我们就在 jenkins 新建一个 job 吧，输入了项目名称，就进入到设置项；

丢弃旧的构建

这里的丢弃旧的构建，可选，但是习惯选择 7 天，，最大保留 300 个；
原因是，jenkins 每次构建都会生成一个历史构建记录及对应的产物，如果公司有 100 个产品，每天自动打包 10 次，一天就有 1000 个产物，服务器磁盘空间是个问题，因此设置个 7 天，设置个最大数，定时删除即可；

• 持构建的天数：根据你所填写的天数来保存构建记录
• 保持构建的最大个数：有几条构建记录就保存几条
• 发布包保留天数：发布的产物保存的天数
• 发布包最大保留 # 个构建：发布了多少个产物就保存多少个

上面的丢弃旧构建不是要点，继续；

继续下滑，会发现Source Code Management，中文是源码管理，而我们的代码是存放到 gitlab 的，因此就选择 git 了，点击后如下图展开；

这里有小伙伴可能有疑问，既然是放 gitlab，为啥不是选择 gitlab，而是选择 git？

git、github、gitlab

这里就花点时间说明下 git、github、gitlab；

git 是一款免费的、开源的分布式版本管理控制系统（工具）；

gitHub 是一个面向开源及私有软件项目的托管平台，
只支持 git 作为唯一的版本库格式进行托管；

gitlab，是一款基于 Git 的项目管理软件，拥有 GitHub 拥有的一切，但它还具备让团队对它们的 repositories 进行控制的功能；

希望经过这么一说，能让你稍微清楚下；

源码管理

点击 git，把项目的地址 copy 到这里；

没权限是肯定的，那我们就点击add创建账户呗，选择 jenkins；

输入 gitlab/github 的账号密码，但是输入完后发现还是报错；

别着急，那去服务器上看看，git 安装了吗？

没安装，那就安装罗；

yum install git

等待安装完，再输入git --version跟where is git来看版本及安装位置；

安装完后，就顺便试试能不能 clone 项目吧；

不出所料，果然不行，因为还要配置密钥啊；

$ ssh-keygen -t rsa -C "your_email@youremail.com"
//注意，双引号里面是你的邮箱。填你注册 github 的邮箱就行了。按 enter 执行。

一路回车就行，密码一般不用设置~

上图红框里的就是地址，cd 过去；

有id_rsa和id_rsa.pub两个文件，这两个就是 SSH Key 的秘钥对，
id_rsa是私钥，不能泄露，
id_rsa.pub是公钥，可以公开;

配置 ssh
在 git bash 执行 cat id_rsa.pub,把输出的内容 copy 出来，然后打开 gitlab/github 网站，点击右上角自己的图标，点击Setting->ssh key 页面，点击add ssh key~

这里还有一个特殊的问题：
因开放公网的原因，每次git clone的下载代码的时候是连接的https://而不是git@git (ssh)的形式，导致每次 pull/push 等远程操作的时候，都需要输入账号密码，非常麻烦；

解决办法：

在项目根目录输入：
git config --global credential.helper store
git pull/git push（第一次要再输入一次，以后就不用）
会在用户目录下生成文件.git-credential 记录用户名密码的信息；

那回到 jenkins，打开测试 job 的设置，再看是否正常；

发现已经好了，没问题，当然也会有小伙伴依然有问题，那就需要这样做；

• 打开 jenkins 首页
• 点击系统管理
• 全局工具设置
• 修改 git 地址

打开后，滑动到 git 栏，如果有问题的话，可能会看到错误提示:

There's no such executable git in PATH: /sbin, /usr/sbin, /bin, /usr/bin.

在出错的地方填入：

"whereis git"的地址 + "/bin/git"
（如上面"whereis git"的地址为"/usr/bin/git"，则应该填入 "/usr/bin/git/bin/git"）并保存

然后再回到 job 的源码管理中添加 git 地址，就会好了；

既然可以连接到 gitlab 了，那我们就直接下滑到 build，选择 add build step，因为是服务器，所以直接选择执行shell，如果是 Windows 系统，也可以选择执行Windows批处理命令；

因 jb 的项目里面有个test.py文件，那项目 clone 下来肯定是想执行这个文件啦，因此内容就是输入python test.py，然后点击保存；

回到 job 的首页，点击立即构建；

因test.py的作用是向钉钉发一条消息，因此成功的话，钉钉就会收到一条信息；

到这里，说明 jenkins 是对接到 gitlab 是通的了；

触发任务

看看标题，目的是：提 tag 自动打包

那先看看，tag 是怎么生成的？
具体看git 命令行第 11 章，这里有说明；

这里就不 bb 了，直接贴：

git tag -a '3.4.0/1811111212' -m 'jbtest tag'
git push --tags

• 创建一个含附注类型的标签非常简单，用-a指定标签名字即可；
• -m 选项则指定了对应的标签说明；
• git push --tags就是一次推送所有本地新增的标签；

然后再输入git tag查看当前 tag 信息；

既然知道 tag 是怎么生成的，那就看看有没有办法知道 tag 被创建了？

第一时间当然是想到钩子-hook啦；

来看下官方解释：

钩子 (hooks) 是一些在"$GIT-DIR/hooks"目录的脚本, 在被特定的事件 (certain points) 触发后被调用。
当"git init"命令被调用后, 一些非常有用的示例钩子文件 (hooks) 被拷到新仓库的 hooks 目录中; 但是在默认情况下这些钩子 (hooks) 是不生效的。 把这些钩子文件 (hooks) 的".sample"文件名后缀去掉就可以使它们生效了。

简单地来说有点类似回调，就是特定事情完成后回调执行事件。

那这钩子，在jenkins跟gitlab上怎么搞？gitlab支持吗？

gitlab 钩子

打开gitlab对应的项目，点击settings-Integrations（集成）

打开后，就是 hook 的内容啦，简单瞄下，发现有个选项叫Tag push events，看了下描述，好像蛮符合我们的要求，界面显示，需要输入URL跟Secret Token，这两玩意怎么来？

jenkins 获取 URL 跟 Secret Token

打开 jenkins，打开对应的 job，点击设置，查找Build when a change is pushed to GitLab，gitlab 上的 URL 就是该处的链接，如下图红框，复制过去即可；

同时点击右下的Advanced(高级)按钮；

然后点击右下的Generate按钮；

然后会生成一串 Secret token，复制到 gitlab 那；

那我们再试试，直接在服务器打个 tag 且 push 看钉钉会不会收到信息？

啧啧啧，没问题啊，搞定啦，另外看了下 hook，支持的内容蛮多的，tag push、push event、merge requests等；

gitlab 没有 setting 权限

上面说的条条是道，但实际现实是残忍的，打开实际的项目，会发现自己没有setting权限:

遇到这种情况，不是说不能处理，只能看门槛变高了，有 2 个方法：

尝试跟对应的负责人沟通，看能否给一个带 master 权限的账号；

如果有足够的数据让老大认可这个功能，就会给一个带 master 权限的账号，就可以为所欲为啦；

但如果给的理由不让人信服或者老大觉得没卵用，但依然要做这个功能，那只能换种方式了，但至少要求依然有仓库的可读权限；
换个角度，连仓库权限都没有，就别想做了。。

大致的思路就是，利用定时功能，不断检测该项目的 tag，当发现原 tag 不是最新 tag 时，就认为有最新 tag，此时再通知 jenkins 处理；

如果是这样，那 jenkins 上的选项会有点不同，构建的时候就要选择脚本调用，指定 TOKEN_NAME，然后可以通过连接JENKINS_URL/job/JOBNAME/build?token=TOKEN_NAME来启动build；

对了，做这个功能，还有两种形式：

• 检测脚本放到产品项目根目录下；
• 检测脚本单独一个项目；

第一种方式的好处时，省事，但是一般不允许，因为产品项目一般存放跟该产品相关的内容，而这个脚本典型是通用的，后面如果多个产品想复用就麻烦了

第二种方式的就是独立项目，可复用，把检测项目跟产品项目放到同一台 jenkins 机器上，这样它们都在jenkins/workspace目录下，通过传参的方式切换不同目录即可；

而 jb 采用的是第二种方式；

检测脚本

这个脚本的目的是什么？
就是定时检测 tag 是不是最新的，如果不是，则执行相应操作；

那难度就在于，怎么判断 tag 是不是最新的？
Google 下，有例子：

git describe --tags git rev-list --tags --max-count=1

尝试下，好像没问题，那就暂且相信吧；

好奇问下，这命令到底是啥意思？

其实这是两条 git 命令；

git describe --tags
git rev-list --tags --max-count=1

git describe --tags
显示当前离当前提交最近的 tag，实际发现，带不带参数都一样？

不加任何参数的情况下，git describe 只会列出带有注释的 tag；

实际，该命令是可以带 3 个参数的，tags、always、dirty，这一般用的比较少，不展开说明；

git rev-list --tags --max-count=1

git-rev-list :按反向时间顺序列出提交对象
意思就是把倒序方式展示最新提交内容；

max-count=1，也很好理解，只获取 1 个，如果写 2，则获取 2 个；

那命令实际就变成了这样：

git describe 9c7246b2026cec052af6a3b6297995e494c7b398

最终输出的就是 tag，有种奇淫怪招的感觉；

当然，不会用 git 的话，也有另外一种方式达到获取最终一个 tag 的效果：

#获取tag信息，转list
content = os.popen("git tag" ).read().split("\n")
for i in content:
    if ( i != ''):
        tag_list.append(i)

print(tag_list[-1])

就是输入git tag，获取所有 tag 信息，再重新存在一个 list，只拿最后一个，也可以再做下判断，只保存最后一条，方式很多，类似，但这种效果不好是，假如一个项目经过多轮迭代，有几千条 tag，就需要时间了，因此还是推荐第一种；

为了模拟真实场景，就在跟目录下新建一个脚本，跟项目同一根目录；

脚本的内容如下：

# _*_ coding:utf-8 _*_
import re
import os
import sys
import json
import time
import requests
from apscheduler.schedulers.blocking import BlockingScheduler

tag = ""
scheduler = BlockingScheduler()
base_dir = os.getcwd()

def postDingDing(content):
    dingdingurl = ["https://oapi.dingtalk.com/robot/send?access_token=你的钉钉token"]
    headers = {'Content-Type': 'application/json'}
    String_textMsg = {
        "msgtype": "markdown",
        "markdown": {
            "title" : "有新tag啦",
            "text":   "新tag:  "+content
        }
    }
    requests.packages.urllib3.disable_warnings()
    String_textMsg = json.dumps(String_textMsg)
    for i in dingdingurl:
        requests.post(i, data=String_textMsg, headers=headers, verify=False)


def getProjectsName():
    if len(sys.argv) > 1:
        return sys.argv[1]
    else:
        print("没有传项目参数，请重新输入，例子：python check_gittag.py jbtest")

def check_tag(dir):
    os.chdir(base_dir+"/"+dir)
    # 原型：git describe --tags 'git rev-list --tags --max-count=1'
    id = os.popen("git rev-list --tags --max-count=1").read()
    content = os.popen("git describe --tags "+ id).read()
    return content


def start_task():
    global tag
    projects_name = getProjectsName()
    last_tag = check_tag(projects_name)

    if (tag != last_tag):
        print("有新tag啦：  "+last_tag)
        postDingDing(last_tag)
        tag = last_tag
    # else:
    #     print("没有新tag，继续轮训")

def get_time():
    """
    获取当前时间
    """
    return time.strftime("%Y-%m-%d %H:%M:%S", time.localtime())


if __name__ == "__main__":
    print(get_time() + " 魔法仪式已启动！")
    scheduler.add_job(start_task, "interval", seconds=6, id="check_tag")
    scheduler.start()

因为是用来测试，因此 jb 是做了通知钉钉的功能，执行上面的代码，会发现有一个问题：push 了新 tag，没有通知！！！

后来想了下，哦，是没有，因为本地的代码还是旧的，比如研发本地 push 到仓库，但是检测脚本是在服务器 A，那肯定是不会知道有代码更新啦；

解决方案，马上想到，那 push 后就通知啊，结果想起，没钩子权限。。

那没问题，在上面的脚本加多一个更新命令就好啦；

# 更新远程代码到本地仓库
git fetch origin

流程通了，那怎么对接到 jenkins？

再接 jenkins

看回 jenkins，按照要求试试，输入以下命令：

curl -i jenkins_url/job/job_name/build?token=yourtoken

结果出现 403.。。

两种解决方案：

• 使用其他插件代替
• jenkins 全局安全点击下图红框内容，jenkins 首页 - 系统管理 - 全局安全设置；

jb 选择的是第二种方案，勾选后，再次运行上面的命令，没问题，并且可以收到啦~

再看钩子

其实故事到上面就完啦，但是呢，虽然知道 hook 怎么用，但还是想了解更多，因此就有了这篇啦；

什么是钩子

Git Hooks 就是在 Git 执行特定事件（如 commit、push、receive 等）后触发运行的脚本。

按照 Git Hooks 脚本所在的位置可以分为两类：

• 本地 Hooks，触发事件如 commit、merge 等；
• 服务端 Hooks，触发事件如 receive 等；

钩子能做啥

基本上，用上钩子都是定制化的脚本程序，在实际工作中，基本钩子是万能的，如：

• post-receive：每当有新的提交的时候就通知项目成员；
• pre-commit：检查每次的 commit message 是否符合编码规范；
• post-merge：当 merge 成功后，通知项目成员；

钩子放哪里

$project_name/.git/hooks

在.git/hooks/文件夹下。当你 init 一个仓库的时候，下边会有一些钩子的例子，以.sample结尾。

当然也可以在这个目录下自由定制 hooks 的功能，当触发一些 git 行为的时候，就会自动触发执行的 hooks 功能；

常见钩子

本地钩子：

名称	功能
pre-commit	当执行commit动作时先执行此hook，可以用此hook做一些检查，比如代码风格检查，或者先跑测试；
prepare-commit-msg	当 commit 时需要输入message前会触发此hook，可以用此hook来定制自己的default message信息；
commit-msg	当用户输入commit的message后被触发，可以用此hook校验message的信息，比如是否符合规定，有没有 cr 等；
post-commit	在整个提交过程完成之后会被调用，可以用于发送new commit通知；
post-checkout	由git checkout命令调用，可以用于为自己的项目设置合适的工作区，比如自动生成文档、移动一些大型二进制文件等，也可以用于检查版本库的有效性；
pre-rebase	由git rebase命令调用，可以用来拒绝所有的已经 push 的 commits 进行 rebase 操作；
post-merge	由git merge调用，在merge成功后执行，可以用于 merge 后的消息通知；
post-receive	在成功推送后被调用，适合用于发送通知；
pre-receive	由git push调用，向仓库推送代码时会被执行；
update	在pre-receive之后被调用，分别被每个推送上来的引用分别调用；
pre-push	当 push 时，remote refs 被更新，但是在所有的 objects 传输前被触发；

服务端钩子：

名称	功能
pre-receive	当收到 push 动作之前会被执行；
update	收到 push 动作之前被执行，但是有可能被执行多次，每个 branch 一次；
post-receive	当 push 动作已经完成的时候会被触发，可以用此 hook 来 push notification 等，比如发邮件，通知持续构建服务器等；

自定义钩子

如果想自定义钩子怎么办？
比如现在新增一个jb钩子，用于发送common通知的；

#!/usr/bin/env python

import smtplib
from email.mime.text import MIMEText
from subprocess import check_output

# 获得新提交的git log --stat输出
log = check_output(['git', 'log', '-1', '--stat', 'HEAD'])

# 创建一个纯文本的邮件内容
msg = MIMEText("Look, I'm actually doing some work:\n\n%s" % log)

msg['Subject'] = 'Git post-commit hook notification'
msg['From'] = 'mary@example.com'
msg['To'] = 'boss@example.com'

# 发送信息
SMTP_SERVER = 'smtp.example.com'
SMTP_PORT = 587

session = smtplib.SMTP(SMTP_SERVER, SMTP_PORT)
session.ehlo()
session.starttls()
session.ehlo()
session.login(msg['From'], 'secretPassword')

session.sendmail(msg['From'], msg['To'], msg.as_string())
session.quit()

当然，记得给权限给你钩子，chmod；

小结

好啦，本章就到此接触啦，基础内容有点，但是不多，都是环境配置，本章主要讲述以下内容：

• 搭建 jenkins
• git 配置
• jenkins 打通 git
• gitlab hook
• 检测脚本
• jenkins 通过 url 触发任务
• git tag 命令部分讲解

大致是这样，还有些细节，差不多就的啦；

好啦，如果有什么疑问，欢迎一起沟通；

最后，谢谢大家~