Git 如何配置从GitHub仓库仅同步单个指定文件到本地特定目录

前置准备 #

• 本地已完成Git环境配置，拥有目标GitHub仓库的拉取权限
• 提前创建好用于存放同步文件的目标目录，记为$TARGET_DIR
• 记你本地克隆的GitHub仓库路径为$REPO_DIR，需要同步的单个文件在仓库内的相对路径为$TARGET_FILE_PATH

方案1：Git钩子触发同步（适合仅你本地推送更新的场景） #

你本地提交/推送代码时自动触发同步，无需额外定时任务，延迟最低：

配置步骤 #

1. 进入本地仓库的Git钩子目录

cd $REPO_DIR/.git/hooks

2. 新建并编辑post-commit钩子文件（提交代码后自动执行）

touch post-commit
chmod +x post-commit

3. 往post-commit文件内写入以下逻辑：

#!/bin/bash
# 检测本次提交是否修改了目标同步文件
if git diff --name-only HEAD~1 HEAD | grep -q "$TARGET_FILE_PATH"; then
    # 直接复制本地仓库最新的文件到目标目录
    cp "$REPO_DIR/$TARGET_FILE_PATH" "$TARGET_DIR/"
    # 如果你需要同步的是已经推送到远程的版本，把上面的cp命令替换为下面的稀疏检出逻辑即可
    # cd $TARGET_DIR && rm -rf temp_repo
    # git clone --depth 1 --filter=blob:none --sparse [你的GitHub仓库SSH/HTTPS地址] temp_repo
    # cd temp_repo && git sparse-checkout set $TARGET_FILE_PATH
    # cp $TARGET_FILE_PATH $TARGET_DIR/ && rm -rf ../temp_repo
fi

注意：使用Git稀疏检出拉取单个文件可以避免拉取整个仓库内容，大幅提升同步速度

方案2：定时检测同步（适合有其他协作者修改仓库的场景） #

如果有其他人也会往仓库推送目标文件的更新，可以配置定时任务定期拉取检测更新：

配置步骤 #

1. 新建同步脚本，例如存为~/sync_single_file.sh，写入以下内容：

#!/bin/bash
# 临时拉取远程仓库的目标文件做对比
cd /tmp && rm -rf temp_sync_repo
git clone --depth 1 --filter=blob:none --sparse [你的GitHub仓库SSH/HTTPS地址] temp_sync_repo > /dev/null 2>&1
cd temp_sync_repo
git sparse-checkout set $TARGET_FILE_PATH > /dev/null 2>&1

# 对比文件哈希判断是否需要更新
new_file_hash=$(md5sum $TARGET_FILE_PATH | awk '{print $1}')
exist_file_hash=$(md5sum $TARGET_DIR/$(basename $TARGET_FILE_PATH) 2>/dev/null | awk '{print $1}')
if [ "$new_file_hash" != "$exist_file_hash" ]; then
    cp $TARGET_FILE_PATH $TARGET_DIR/
    echo "$(date): 目标文件已完成同步更新" >> ~/sync_file_log.log
fi
rm -rf /tmp/temp_sync_repo

2. 给脚本添加执行权限

chmod +x ~/sync_single_file.sh

3. 配置定时任务，例如设置每10分钟检测一次
   执行crontab -e，在打开的编辑器末尾添加一行：

*/10 * * * * ~/sync_single_file.sh

注意事项 #

• 所有占位变量$REPO_DIR、$TARGET_DIR、$TARGET_FILE_PATH、GitHub仓库地址都需要替换为你自己的实际路径和地址
• 若目标仓库为私有仓库，需提前配置好SSH密钥或Git凭证存储，确保拉取代码不需要手动输入密码
• Windows系统可将上述shell脚本替换为bat脚本，定时任务使用系统自带的「任务计划程序」配置即可
• 若同步的文件需要保留执行权限，可在复制完成后额外添加chmod语句调整权限

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