1. 需求背景
公司有后台项目和前端项目,后台和前端是分开部署的,后台是用svn进行代码管理,并且通过jenkins进行持续集成和构建,但是前端还是用着最原始的方式通过上传js,html文件到web服务器进行发布,主要是造成了以下的问题:
- 部署麻烦,需要知道本地文件所在目录和线上文件所在目录,然后进行上传
- 容易遗漏,在文件多的时候上传会有遗漏情况发生,导致线上出问题
- 发布流程不易管理,无法追踪发布时间,发布目的,发布内容
综上几点,再加上前端的代码是通过码云的git进行托管的,所以jenkins配置码云的代码来实现自动部署迫在眉睫。
2. 过程
2.1 目标
jenkins配置码云自动部署的目标是在指定分支上进行push到远程库的时候能够触发jenkins的构建,然后实现自动化部署上线。
2.1 寻找解决方案
在网上能看到很多部署方案,但是大都大同小异,描述得很不详细,没有从码云这个托管平台的实际出发来讲如何部署,后面通过翻阅码云的帮助文档,再加上自己的一些经验,终于实现了通过jenkins自动配置码云
2.2 部署过程
2.2.1 jenkins安装码云Gitee插件
系统管理 --> 插件管理 --> 搜索插件(安装),重启即可(下图是我在安装好的插件中查询出来的,我是已经安装好的了)
2.2.2 插件配置
jenkins --> 系统管理 --> 系统设置 ,找到
Gitee 配置
选项
- 链接名:输入你想要的名字,这个名字无所谓,后面只是做显示作用
- Gitee 域名 URL:输入码云完整URL地址,https://gitee.com(码云私有化客户输入部署的域名),一般填
https://gitee.com
即可 - 证书令牌:右边选项点击
add
,选择jenkins
,- Domain:选择
全局凭据(Global credentials)
- 类型(Kind):选择
Gitee API 令牌(Gitee API Token)
- 范围(Scope):根据你个人想要这个凭据在哪个范围可使用,我选的是全局
- Gitee APIV5 私人令牌(Gitee API Token):输入你的码云私人令牌,获取地址
https://gitee.com/profile/personal_access_tokens
- ID和描述:自己随便填,也是作为显示使用而已
添加完成后,选择刚自己添加的这个令牌
- Domain:选择
- Advanced:可配置是否忽略 SSL 错误(适您的Jenkins环境是否支持),并可设置链接测超时时间(适您的网络环境而定),我是忽略掉的了。
- 测试连接:点击可以确定自己的配置是否正确,如果不正确,则根据插件配置重新再走一遍。
2.2.3 新建构建任务
选择自由风格的构建项目,然后开始配置:
- 选择gitee地址
- 源码管理配置
- 点击
Git
,Repository URL
输入git地址,Credentials
选择无即可(前提是我们已经把jenkins所在服务器的公钥配置在码云上了,该服务器可以直接使用git命令clone或pull码云的代码) - 点击
Advanced
,Name中输入origin
,Refspec输入+refs/heads/*:refs/remotes/origin/* +refs/pull/*/MERGE:refs/pull/*/MERGE
(这个的配置其实我并不是很懂) - Branch Specifier (blank for ‘any’)输入
origin/${giteeSourceBranch}
- 源码管理配置的其他都默认选项即可
- 点击
- 触发器配置
- 选择
Gitee webhook 触发构建
- 根据自己需要选择
Gitee 触发构建策略
- 其他默认即可
- 选择自己需要过滤的分支,比如我这个job是构建测试环境的,那么我只希望在push到dev分支上我才要构建,所谓我只有dev分支接口
- 选择
- 新建Gitee WebHook
这是整个配置的核心工作,通过配置WebHook,把我们jenkins相关的地址设置进去,在码云检测到有push动作或其他指定动作的时候,就会调用我们配置的jenkins的地址,然后引发jenkins的构建。
进入源码管理配置中设置的码云仓库中,进入 管理 -> WebHooks
1. 填写URL,该URL在配置jenkins的触发器的时候,会显示
2. 密码填写,在jenkins的配置中生成密码,复制黏贴过去
3. 勾选push,即自己想要触发构建的一些动作
4. 点击测试,在正常的情况下可以发现jenkins已经自动构建了
- 构建过程
接下来就是在build中根据自己业务需求执行相关的构建步骤了,这个和码云部署无关,所以不再赘述。
3. 总结
至此,jenkins配置码云自动部署已经全部设置完毕,当有开发在本地的push代码大远程的dev分支时,就会触发jenkins构建。从此,前端也走向了自动化部署的道路。
参考链接:
码云的jenkins插件
Linux安装Git