服务器

自建git自动发布

Posted by Nick Deng on 2018-05-20

背景概述

之前的项目都是使用系统自带的 SFTP 功能，然后用类似 FileZilla 类似的软件远程链接主机，然后用文件传输的方式来进行线上的文件更新。

不过这种方式在网站搭建前期是 OK 的，但是当网站的逻辑逐渐变得复杂，更新的文件越来越多，路径越来越多，那么每次更新文件都是一个极其复杂的问题了。

而且如果当文件在更新到线上出现问题的时候，那么退回上一个稳定版本也是相当于又要重复把之前的文件覆盖回来，如果万一有些人大大咧咧没有做任何备份，那么要退回的时候简直就是灾难了。

所以在这样一个背景下，那么一套用 git 简单实现的自动发布系统就能很好的解决这个问题。

前置知识

首先既然用了 git 那么基础的 git 知识就需要了解了，这里不细讲，各位可以去看下廖雪峰大大的 git 教程廖雪峰 git 教程。

自动发布逻辑

在有了基本的 git 知识之后，先来讲讲这个自动发布逻辑是什么。其实这套自动发布系统还是比较简单的，相当于就是先在自己的服务器上搭建一个私有的 git 仓库，然后开发者在本地将代码推送到这个本地的仓库上去，然后在你的网站根目录上 clone 一份代码下来。也就是现在有三个端，开发者端，服务端 git 仓库，网站目录端。

现在要实现的就是当开发者端向服务端 git 仓库推送最新的代码段时，网站目录端会自动将最新的更新版本同步到本地。

那么如果实现这个过程呢，这个地方就要用的 githook 的功能了。

搭建三个端

  • 开发者端这个就不多说了，看了廖雪峰的教程应该基本都懂了简单来说就是下面三个步骤。
1
2
3
$ git init //初始化
$ git add -A
$ git commit -m "搭建本地仓库"

或者你可以等到服务端部署完毕后再 clone 一个远端仓库下来即可。

  • 创建 git 服务端仓库
1
2
3
$ git clone --bare my_project my_project.git
Cloning into bare repository 'my_project.git'...
done.

这个时候本地就会有一个自己项目的裸仓库了
git仓库副本

  • 将仓库放到服务器现在你有了仓库的副本，剩下要做的就是把仓库放到服务器上并设置你的协议。 假设一个域名为 git.example.com 的服务器已经架设好，并可以通过 SSH 连接，我们可以把所有的 Git 仓库放在/opt/git 目录下。 假设服务器上存在 /opt/git/目录，你可以通过以下命令复制你的裸仓库来创建一个新仓库：
1
$ scp -r my_project.git user@git.example.com:/opt/git

这个地方的 user 要有对应目录的相关权限，不过话说在这个阶段大家一般都是会有 root 直接操作的:)。

在这个命令执行成功后，应该在你的服务器上对应的路径就有一个my_project.git的仓库文件了。

现在相当于你有一个叫git.example.com:/opt/git/my_project.git的远程仓库，你现在就可以像操作一些 github 的远程仓库一样操作你这个私有的远程仓库了。例如：

1
$ git clone root@git.example.com:/opt/git/my_project.git

网站目录搭建

比如你现在的网站根目录是/var/www,那么你可以进入你的网站目录中去 clone 你刚刚部署的哪个远程仓库，如果你部署的仓库与你网站的服务器是一台服务器，那么根据上面的你可以直接：

1
2
cd /var/www
git clone  /opt/git/my_project.git

这个时候你就在你的网站目录下部署了一个简单的 git 项目，然后你再把你的服务器访问路径指向到你需要访问的路径。

自动部署 hook 脚本

上面基本上吧三个端都部署完成了，现在就是要走下自动部署脚本，首先找到你部署的服务端 git 仓库，里面有个 hook 文件夹，在这个文件夹下我们创建一个post-receive脚本，然后在这个编辑这个脚本文件，脚本如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
#!/bin/sh


#判断是不是远端仓库

IS_BARE=$(git rev-parse --is-bare-repository)
if [ -z "$IS_BARE" ]; then
echo >&2 "fatal: post-receive: IS_NOT_BARE"
exit 1
fi

unset GIT_DIR
DeployPath="/var/www/my_project"

echo "===================Uncle Plut===================="
cd $DeployPath
echo "deploying the my_project"

＃git stash

#git pull origin master

git fetch --all
git reset --hard origin/master

# gitbook build  如果是gitbook 最好等待一段时间给gitbook build 一些构造时间
# sleep 15  如果只是普通的推送，这两段可以不要

time=`date`
echo "my_project pull at webserver at time: $time."
echo "================================================"

那么现在当这个仓库收到了开发者端的 push 的时候，就会把 master 的最新代码同步到网站的项目目录中去了。

到此自动发布部署完成。

FRIENDS