利用 git 钩子自动部署
在使用 git 管理 Web 项目,以及其它 Server 项目时,我们需要自动部署功能。 在推送后,能将代码部署到工程目录,并执行一些部署命令。 这就用到了 git 为我们提供的 post-update 钩子。
将脚本放在 git-dir/hooks
目录下,命名为 post-update
,并增加可执行权限。
当远端 git 仓库对本仓库发起推送,并推送成功后,该文件将被执行。
你可以用任何你喜欢的脚本语言 bash、python、ruby、julia、PHP、Node.js……
当然,编译型语言也行,只是不如脚本语言那样,便于阅读和修改。
#例 0.
对于简单的部署脚本,使用 bash 即可,例如:
#!/bin/bash
git --work-tree=/path-to/project-dir/ checkout "`git rev-list --tags --max-count=1`" -f >/dev/null
该脚本会将最新的 tag 检出到工程目录,是个常用的用例。
#例 1.
这是一个 Laravel 项目的例子,使用 PHP 编写:
#!/usr/bin/env php
<?php
$product_dir= '/path-to/project-dir/';
$test_dir= '/path-to/test-dir/';
switch( $argv[1] )
{
case 'refs/heads/migrate':
`git --work-tree=$test_dir checkout -f migrate`;
`$test_dir/artisan migrate:fresh --seed`;
case 'refs/heads/test':
`git --work-tree=$test_dir checkout -f test`;
`composer --working-dir=$product_dir dump-autoload`;
`$product_dir/artisan migrate`;
break;
case 'refs/heads/composer':
`git --work-tree=$test_dir checkout -f composer`;
`composer --working-dir=$test_dir update`;
`$test_dir/artisan vendor:publish --all`;
`git --work-tree=$test_dir checkout -f test`;
`composer --working-dir=$product_dir dump-autoload`;
`$product_dir/artisan migrate`;
`git --work-tree=$product_dir checkout -f composer`;
`composer --working-dir=$product_dir update`;
`$product_dir/artisan vendor:publish --all`;
case 'refs/heads/product':
`git --work-tree=$product_dir checkout -f "\`git rev-list --tags --max-count=1\`"`;
`composer --working-dir=$product_dir dump-autoload`;
`$product_dir/artisan migrate`;
`$product_dir/artisan view:clear`;
`$product_dir/artisan route:cache`;
break;
}
此例中,我们检查了被推送的分支,并对不同的分支进行不同的操作。 当 test 分支被推送,将该分支检出到测试目录,并应用新增的数据库迁移文件。 当 migrate 分支被推送,将测试环境中的数据库刷新。 当 product 分支被推送,将最新 tag 检出到生产目录,并处理数据库迁移、视图和路由的缓存。
#例 2.
这是本博客项目的部署脚本:
#!/usr/bin/env ruby
# 引入 git 的 API 库 rugged (基于 libgit2),需要事先使用 gem 安装
require 'rugged'
# 引入 jekyll,需要事先使用 gem 安装
require 'jekyll'
git_repository= '/path-to/git-repository/'
project_dir= '/path-to/project-dir/'
web_root_dir= '/path-to/web_root_dir/'
repo= Rugged::Repository.new( git_repository, )
# 获取 tag 列表
tags= repo.tags.map{ |tag| tag.target }
# 构建回溯器,以 master 分支为起点进行回溯
walker= Rugged::Walker.new( repo, )
walker.push( repo.head.target, )
# 回溯获取 master 分支上最新的 tag
latest_tag= walker.find{ |commit| tags.include?(commit) }
# 检出此 tag 到项目目录
repo.workdir= project_dir
repo.checkout( latest_tag.oid, :strategy=>:force, )
# 构建 jekyll 项目
config= Jekyll.configuration( { 'source'=>project_dir, 'distination'=>web_root_dir, }, );
site= Jekyll::Site.new( config, );
site.process
与上面两个例子使用 CLI 不同,本例使用 API 来操作 git 仓库和构建项目。 这看起来略显麻烦,但优势也是明显的。API 往往可以做得比 CLI 更多,也更加灵活。 这里使用的 libgit2 就是非常棒 git API。它涵盖了 git 的所有功能,支持十余种编程语言或环境。 并且它还是 git 的官方推荐 API 库。
以上是我在项目中使用的不同风格的 git post-update 例子。 分享代码,更是分享思路,希望对带来参考价值。