使用 Git 实现 Laravel 项目的自动化部署

简介

在我们的开发过程中,我们不可避免的会用到版本控制。当然,这也致使你对GitSVN有所了解。两者都是出色的版本控制工具,我个人比较习惯用Git,当然这可能和个人习惯有关。不知道大家一开始是怎么使用 git 进行开发的,反正我个人是先将代码提交到 github 仓库,然后用SSH登录到服务器,然后进行克隆或者版本更新。听起来就很麻烦,当然实际操作中也很麻烦,那么有什么可以 “一劳永逸“ 的办法呢?请往下看!

简单使用

Git 钩子

什么是git钩子呢?官方解释有些长,简单来说就是一个在特定环境下触发的脚本。这个解释可能不太准确,但是我认为这样更容易理解一些,想了解更多的,可以去Git官网查看,下面我们就用钩子实现自动化部署。

第一步:创建git用户

登录我们的服务器,这里默认你已经安装好了git。创建一个git用户:

# 创建一个名叫jouzeyu的用户
adduser jouzeyu

第二步:给git用户添加权限

#在根目录下的 home 文件夹下创建一个git文件夹
mkdir /home/git 
#切换到创建好的git文件夹
cd /home/git
#创建 .ssh文件夹,里面主要用来放公钥
mkdir .ssh
#切换到.ssh文件夹并创建authorized_keys文件
cd .ssh
touch authorized_keys

第三步:配置git并获取公钥

#在本地配置用户名和邮箱,我的用户名默认为jouzeyu
git config --global user.name "jouzeyu"
git config --global user.email "your email"

注意:如果用了 --global 选项,那么以后你所有的项目都会使用这里配置的用户信息。如果要在某个特定的项目中使用其他名字或邮箱,只需在该项目下执行:

git config user.name "xxx"
git config user.email "xxx"

OK,接下来我们获取公钥,请先查看你的用户下的.ssh文件夹中是否之前就含有公钥和私钥,我们需要寻找一对以 id_dsaid_rsa 命名的文件,其中一个带有 .pub 扩展名。 .pub 文件是你的公钥,另一个则是私钥。如果没有请运行ssh-keygen
使用cat ~/.ssh/id_rsa.pub命令可以获取公钥,复制它,使用vi或者vim命令把它粘贴到我们之前创建的authorized_keys文件中,使用:wq保存。

第四步:初始化仓库

创建一个存放git仓库的文件夹:

mkdir /www/wwwroot/git
cd /www/wwwroot/git

初始化仓库:

#初始化一个裸仓库(强烈建议)
git init --bare website.git
#配置仓库的权限,让我们之前创建好的git用户jouzeyu能读写
chown -R git:git website.git

这里必须注意,如果不给权限,后面的git pull将会报错,原因是没有权限写入。关于裸仓库和普通仓库的区别简单来说就是裸仓库看不到项目文件,普通仓库和你的项目目录一样,只是多了一个.git文件夹。

第五步:生成项目仓库

这个也是在服务器上进行的,同时说明一下/www/wwwroot/是我的环境的根目录。

#创建我服务器上的项目目录test
mkdir /www/wwwroot/test
#克隆仓库
git clone /www/wwwroot/git/website.git
#设置权限
chown -R git website

注意:一定要注意我的路径,git仓库是/www/wwwroot/git,项目仓库是/www/wwwroot/test

第六步:克隆到本地

# 通过ip地址从配置好的线上仓库拉取下来
git clone git@47.97.121.XXX:/www/wwwroot/git/website.git
# 如果有配置域名的话也可以通过域名拉取
git clone git@www.XXX.XXX:/www/wwwroot/git/website.git

因为公钥的原因,这里是不需要密码的,如果成功你的电脑上会出现一个website的文件夹,如果报错请检查后再进行下面的操作。

第七步:测试上传(git pull)

# 打开刚才克隆下来的本地仓库
cd website
# 创建README.md文件
touch README.md
git add .
git commit -m"创建README.md文件"
git push

不出意外已经正常上传了,如果报错请检查权限,上文提到过,如果还不行可以在下方评论。

第八步:添加钩子

终于到重头戏了,写的比较细,所以比较麻烦一些。回到我们线上的服务器,下面的是在线上操作的:

#切换到这个目录
cd /www/wwwroot/git/website.git/hooks
# 生成post-receive文件
touch post-receive
# 使用vim编辑
vim post-receive

post-receive文件里面粘贴:

#!/bin/sh
# 打印输出
echo '======上传代码到服务器======'
# 打开线上项目文件夹
cd /www/wwwroot/test/website
# 这个很重要,如果不取消的话将不能在cd的路径上进行git操作
unset GIT_DIR
git pull origin master
# 自动编译vue项目,如有需要请去掉前面的#号
# npm run build
# 自动更新composer(我暂时没试过)
# composer update
echo $(date) >> hook.log
echo '======代码更新完成======'

保存后给post-receive文件加上运行权限:

chmod +x post-receive

最后一步

在本地修改部分内容,然后提交推送git push,可以看到我们已经实现了自动化部署。

使用Git实现Laravel项目的自动化部署

git
本作品采用《CC 协议》,转载必须注明作者和本文链接
空舟湖上~      ——Jouzeyu
本帖由系统于 4年前 自动加精
lochpure
《L04 微信小程序从零到发布》
从小程序个人账户申请开始,带你一步步进行开发一个微信小程序,直到提交微信控制台上线发布。
《L02 从零构建论坛系统》
以构建论坛项目 LaraBBS 为线索,展开对 Laravel 框架的全面学习。应用程序架构思路贴近 Laravel 框架的设计哲学。
讨论数量: 22
aodaobi

正常情况也就测试环境需要自动部署吧,生产环境 难道都是git 提交就推送?

4年前 评论
lochpure (楼主) 4年前
mengdodo 4年前
EsonSheng78 3年前

我这边用的也是 Git Webhook 执行 action: push 操作 自动更新代码, 就忘了那个 更改用户权限问题了 chown -R www:www your-project-path

4年前 评论

这种方式比较传统,仅适用于单一环境,如果有 develop、preview、production 等环境,还是用专业的自动化部署工具方便!

4年前 评论
SamCCC 4年前
GeorgeKing (作者) 4年前

挺详细的

4年前 评论

点赞 之前公司一个老项目也是怎么做的 然后最后一步的 git pull

file 应该改为git push

4年前 评论

个人项目,用 GitHub 的 WebHook

4年前 评论

学习到了,Mark走一波

4年前 评论
UKNOW

git不是使用SSH 可以用吗

4年前 评论

如果git仓库和项目不在一个服务器,shell脚本应该就不对了吧

4年前 评论
xin6841414

项目依赖github或者gitlab,我还是选择webhook吧 :joy:

4年前 评论

file这个怎么处理,没有权限吗?

4年前 评论

感谢分享,正好适合我现在的情况

1年前 评论
sinmu (作者) 1年前

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!