如何在GitLab的post-receive钩子中获取用户输入？自动部署脚本优化求助

我之前也遇到过类似的需求，要让自动部署脚本能根据开发者指定的项目名来执行不同的部署流程。下面分享几个可行的方案，帮你解决这个问题：

方案1：通过Commit Message传递参数（最推荐） #

这是最通用且无需额外配置的方式，开发者只需要在提交代码时，把项目名等信息放在commit message里，脚本解析后即可使用。

实现步骤： #

1. 约定Commit Message格式：和团队约定好格式，比如用[deploy:project=xxx]来标记要部署的项目，例如：

   git commit -m "[deploy:project=user-service] 修复用户登录超时问题"

2. 修改post-receive钩子脚本：在脚本中提取commit message里的项目名，示例代码如下：

   #!/bin/bash
   
   # 读取Git传递的三个默认参数：旧版本号、新版本号、推送的分支名
   OLD_REV=$1
   NEW_REV=$2
   REF_NAME=$3
   
   # 获取本次推送的最后一条Commit Message
   COMMIT_MSG=$(git log -1 --pretty=format:"%B" $NEW_REV)
   
   # 正则匹配提取项目名
   if [[ $COMMIT_MSG =~ \[deploy:project=([a-zA-Z0-9_-]+)\] ]]; then
     PROJECT_NAME=${BASH_REMATCH[1]}
     echo "触发自动部署：项目 $PROJECT_NAME"
     
     # 这里替换成你的部署逻辑，比如调用对应项目的部署脚本
     if [ -f "./deploy_${PROJECT_NAME}.sh" ]; then
       ./deploy_${PROJECT_NAME}.sh
     else
       echo "错误：未找到项目 $PROJECT_NAME 的部署脚本"
       exit 1
     fi
   else
     echo "Commit Message中未找到部署标记，跳过自动部署"
     exit 0
   fi
   

3. 脚本权限配置：确保钩子脚本有执行权限：

   chmod +x /path/to/your/git/repo/.git/hooks/post-receive
   

方案2：通过Git Push时的环境变量传递（适合特定场景） #

如果团队内部有统一的开发环境配置，可以让开发者在push前设置环境变量，钩子脚本读取该变量。但这种方式需要开发者本地配置，适合小团队。

实现步骤： #

1. 开发者本地设置环境变量：push前执行：

   export DEPLOY_PROJECT=order-service
   git push origin main
   

2. 钩子脚本读取环境变量：GitLab在执行钩子时会继承部分环境变量（注意：GitLab的共享钩子可能需要额外配置环境变量传递），脚本中可以直接读取：

   #!/bin/bash
   
   if [ -n "$DEPLOY_PROJECT" ]; then
     echo "部署指定项目：$DEPLOY_PROJECT"
     # 执行部署逻辑
   else
     echo "未指定部署项目，跳过"
     exit 0
   fi
   

常见问题排查 #

• 脚本未执行：检查脚本是否有可执行权限，以及GitLab用户（通常是git用户）是否有脚本所在目录的访问权限。
• Git命令报错：脚本中使用git命令时，最好用绝对路径（比如/usr/bin/git），因为GitLab执行钩子时的环境变量PATH可能和用户本地不同。
• Commit Message解析失败：测试正则表达式是否能匹配所有约定的格式，比如包含特殊字符的项目名是否能正确提取。

内容的提问来源于stack exchange，提问作者Mansoor