使用Git Hooks优雅地管理服务器上项目多环境的部署

[Valdanitooooo]

背景

• 项目架构简单，组件少
• 没有 CICD 环境
• 通过 git 管理，但还不需要多分支
• 需要多个环境的部署，例如测试环境和生产环境

多环境部署脚本

以一个 web 项目为例，不同的环境部署脚本放在不同目录中，在 docker-compose脚本中 mount 各自目录

├── Dockerfile                       # 构建项目基础镜像，安装所需依赖，不包含源代码
├── deploy
│   ├── nginx
│   │   ├── dev                           # 开发环境
│   │   │   ├── nginx.conf            # 反向代理静态资源、API等
│   │   │   └── openresty_lua
│   │   │       └── oidc
│   │   │           └── acc.lua         # 用于用户认证
│   │   ├── prod                          # 生产环境
│   │   │   ├── nginx.conf
│   │   │   └── openresty_lua
│   │   │       └── oidc
│   │   │           ├── acc.lua
│   │   └── test                            # 测试环境
│   │       ├── nginx.conf
│   │       └── openresty_lua
│   │           └── oidc
│   │               ├── acc.lua
├── docker-compose-dev.yml
├── docker-compose-prod.yml
├── docker-compose-test.yml

Git Hooks 脚本

收下在服务器分别拉取两遍 git 仓库到不同目录，比如：test_app 和 prod_app

代码都是一样的，只是为了防止误操作

然后进一步防止误操作！

分别在各自目录编辑一个.git/hooks/post-merge文件并给予执行权限chown +x .git/hooks/post-merge

脚本内容，例如测试环境的post-merge脚本内容如下：

#!/bin/sh

check_and_apply_skip_worktree() {
    path=$1
    if [ -e "$path" ]; then
        if [ -d "$path" ]; then
            echo "Path '$path' is a directory. Applying skip-worktree to files within the directory."
            find "$path" -type f | while read file; do
                git update-index --skip-worktree "$file"
                echo "Skip-worktree applied to file: $file"
            done
        else
            git update-index --skip-worktree "$path"
            echo "Path '$path' is a file. Skip-worktree applied."
        fi
        rm -rf "$path"
    else
        echo "Path '$path' does not exist. No action taken."
    fi
}

check_and_apply_skip_worktree "deploy/nginx/dev"
check_and_apply_skip_worktree "deploy/nginx/prod"
check_and_apply_skip_worktree "docker-compose-dev.yml"
check_and_apply_skip_worktree "docker-compose-prod.yml"

如果是生产环境就是将下面改为

check_and_apply_skip_worktree "deploy/nginx/dev"
check_and_apply_skip_worktree "deploy/nginx/test"
check_and_apply_skip_worktree "docker-compose-dev.yml"
check_and_apply_skip_worktree "docker-compose-test.yml"

Git Hooks实现的效果

总结上一步做的这些目的是：

1. 相同分支不同环境的部署脚本互不干扰，防止误操作
2. 在测试环境目录不跟踪 dev 和 prod 的脚本变化并将其删除，这样完全不会误操作，生产环境目录同理
3. 核心操作就是下面这两行

git update-index --skip-worktree "$path"
rm -rf "$path"

每次手动操作也能实现，但手动操作一方面比较麻烦，另一方面当有代码更新时，又会 pull 下来其他环境的脚本，所以放在Git Hooks里非常合适，每次 pull 之后自动执行以上操作