很多人在实际开发中仍旧使用 FTP 工具上传或者使用手动到服务器使用 git 拉取代码,不仅操作不方便,而且效率很低,在这里对使用代码托管平台的 webhook 实现代码的自动化部署做一些总结和分享。
- 实现部署的前提条件也是必须条件是:必须有一台可以公网访问的服务器,并且安装了 git 版本控制工具,本文主要介绍 webhooks 的部署使用,并且已经假定你已经部署好了服务器的 php 和 nginx 环境。
- 环境部署环境部署环境使基于阿里云的 liux 系统服务器( centos7.2 的操作系统+ nginx1.10.2 服务器+ php7.0.16 )。
- 配置 www.conf 相关的设置,配置的默认组和用户是 apache 但是这里使用的是 nginx 服务器,所以需要将用户组和用户修改为 nginx 以确保文件执行时能够具有相关的权限,修改完城后重启 php 服务。
shell
; RPM: apache Choosed to be able to access some dir as httpd
user = nginx
; RPM: Keep a group allowed to write in log dir.
group = nginx
- nigx 的执行权限配置,由于默认的 nginx 用户是没有执行权限的,这里需要手动给 nginx 用户添加执行权限,修改完城重启 nginx 服务。
shell
usermod -s /bin/bash nginx
配置 git
5.1 为 nginx 用户生成 git 的访问公钥文件,注意这里的邮箱要和你代码托管平台的邮箱保持一致(楼主这里使用的代码托管是是码云),生成过程中使用默认配置直接 enter 即可,注意公钥的保存位置,不同用户保存位置可能不一样。
sudo -Hu nginx ssh-keygen -t rsa -C "[email protected]"
5.2 查看生成的公钥,复制公钥添加到相关的到代码托管平台.
cat /var/lib/nginx/.ssh/id_rsa.pub
注:码云用户点击自己的头像,选择修改资料,选择左侧的 ssh 公钥完成添加,github 用户点击自己的头像,选择 settings ,选择左侧的 ssh and gpg keys ,选择 new ssh key 添加公钥。其他平台用户请自行查找平台的设置。
5.3 配置代码托管平台的 webhooks
注:码云用户点击自己的项目,选择上方的管理选项,选择左侧的 webhooks 选项,填写自己 hook 文件访问地址和密码,勾选 hook 触发条件,点击保存。 github 用户,点击自己的项目选择上方导航的 settings 选项选择左侧的 webhooks 选项,填写 hook 文件地址及密码,选择发送的请求数据格式,选择触发条件,点击 add hook。
5.4 配置服务器全局的 git 用户和邮箱。
git config --global user.name "test" git config --global user.email "[email protected]"
使用 sh 方式将代码克隆至自己网站目录,注意为了避免文件权限混乱,这里需要指定用户。
shell
sudo -Hu nginx git clone [email protected]:test/test.git
- 配置网站的根目录用户用户组为
nginx
shell
chown -R nginx:nginx your webroot
- 编写 hook 脚本,此脚本需要能够通过 web 访问。这里以 web 访问根目录为例。
php
// vim hook.php
<?php
error_reporting(1);
// 网站的web目录
$target='your webroot';
$token='testpwd';
$json=json_decode(file_get_contents('php://input'),true);
if($json['password']!=$token){
exit('error request');
}
$cmd=" sudo -Hu nginx cd $target ; git pull 2>&1";
shell_exec($cmd);
- 至此所有的 webhooks 的部署已经完成,赶紧向远程推送代码,看看服务器是不是已经获取了最新的代码了吧!