如何通过Python脚本实现GitHub远程仓库变更时本地自动git pull

完全可以通过Python脚本实现远程仓库更新自动检测、自动同步到本地，无需手动执行git pull，根据使用场景可选以下两种实现方式：

定时轮询方案（零额外配置，适合本地日常使用） #

该方案不需要修改GitHub仓库配置，按设定间隔对比远程与本地版本差异，检测到更新就自动拉取，部署成本最低。

• 安装依赖：执行命令pip install gitpython apscheduler
• 实现逻辑：定时拉取远程仓库的元数据，对比本地当前分支与远程对应分支的commit哈希值，哈希不一致则说明远程有更新，确认本地无未提交改动后执行pull操作，避免文件冲突。
• 可直接运行的参考脚本：

import time
from git import Repo
from apscheduler.schedulers.blocking import BlockingScheduler

# 按需修改以下配置项
LOCAL_REPO_PATH = "/your/local/repo/absolute/path"  # 本地克隆仓库的绝对路径
CHECK_INTERVAL_MINUTES = 5  # 远程仓库检测间隔，单位：分钟
TARGET_BRANCH = "main"  # 需要同步的分支名，常见为main或master

def auto_sync():
    try:
        repo = Repo(LOCAL_REPO_PATH)
        remote_origin = repo.remotes.origin
        # 获取远程最新分支信息，不修改本地文件
        remote_origin.fetch()
        
        local_commit_hash = repo.head.commit.hexsha
        remote_commit_hash = repo.refs[f"origin/{TARGET_BRANCH}"].commit.hexsha

        if local_commit_hash != remote_commit_hash:
            print(f"[{time.strftime('%Y-%m-%d %H:%M:%S')}] 检测到远程分支更新，本地版本：{local_commit_hash[:7]}，远程版本：{remote_commit_hash[:7]}，开始同步")
            # 检测本地是否有未提交改动，避免pull冲突
            if repo.is_dirty(untracked_files=True):
                print("检测到本地存在未提交改动，为避免冲突跳过本次同步，请先处理本地文件变更")
                return
            remote_origin.pull()
            print(f"[{time.strftime('%Y-%m-%d %H:%M:%S')}] 同步完成，当前最新版本：{repo.head.commit.hexsha[:7]}")
        else:
            print(f"[{time.strftime('%Y-%m-%d %H:%M:%S')}] 检测无更新，无需同步")
    except Exception as e:
        print(f"同步过程出现错误：{str(e)}")

if __name__ == "__main__":
    # 脚本启动时先执行一次同步
    auto_sync()
    # 启动定时任务
    scheduler = BlockingScheduler(timezone="Asia/Shanghai")
    scheduler.add_job(auto_sync, "interval", minutes=CHECK_INTERVAL_MINUTES)
    print(f"自动同步服务已启动，每{CHECK_INTERVAL_MINUTES}分钟检测一次远程仓库更新")
    scheduler.start()

• 使用注意事项：
  • 提前配置好Git的拉取凭证，用SSH方式克隆仓库可直接免密操作，HTTPS方式需提前将凭证存入Git凭证管理器，避免pull时要求输入账号密码
  • 如果不需要保留本地任何改动，可在pull逻辑前添加repo.git.reset('--hard', f'origin/{TARGET_BRANCH}')强制覆盖本地文件，该操作会永久删除所有本地未提交的修改，请确认风险后再使用
  • 脚本需长期在后台运行，Windows可通过任务计划配置开机自启，Linux/macOS可配置systemd服务或通过nohup命令后台启动。

Webhook触发方案（实时同步，适合有公网回调条件的场景） #

如果要求远程仓库更新后立刻同步，不需要等待轮询间隔，可以用GitHub的Webhook能力实现事件触发式同步，实时性更高。

• 配置步骤：进入GitHub仓库的Settings -> Webhooks页面添加新Webhook，填写本地服务的公网回调地址，设置自定义签名密钥，选择触发事件为Push、Pull requests merged即可。
• 实现逻辑：本地启动一个轻量HTTP服务接收GitHub推送的事件，校验请求签名合法后，判断是目标分支的更新事件就立刻执行pull操作。
• 参考实现代码：

from flask import Flask, request
from git import Repo
import hmac
import hashlib
import time

app = Flask(__name__)
# 按需修改以下配置项
WEBHOOK_SECRET = "your_custom_webhook_secret"  # 和GitHub配置的Webhook密钥保持一致
LOCAL_REPO_PATH = "/your/local/repo/absolute/path"
TARGET_BRANCH = "main"

@app.route("/github-webhook", methods=["POST"])
def handle_webhook():
    # 校验请求签名，防止伪造请求
    signature_header = request.headers.get("X-Hub-Signature-256")
    if not signature_header:
        return "非法请求", 403
    sha_type, req_signature = signature_header.split("=")
    mac = hmac.new(WEBHOOK_SECRET.encode(), msg=request.data, digestmod=hashlib.sha256)
    if not hmac.compare_digest(mac.hexdigest(), req_signature):
        return "签名校验失败", 403
    
    # 处理push事件
    event_type = request.headers.get("X-GitHub-Event")
    if event_type == "push":
        payload = request.get_json()
        if payload["ref"] == f"refs/heads/{TARGET_BRANCH}":
            repo = Repo(LOCAL_REPO_PATH)
            if repo.is_dirty(untracked_files=True):
                return "本地有未提交改动，同步失败", 500
            repo.remotes.origin.pull()
            print(f"[{time.strftime('%Y-%m-%d %H:%M:%S')}] Webhook触发同步完成，当前版本：{repo.head.commit.hexsha[:7]}")
            return "同步成功", 200
    return "无需同步", 200

if __name__ == "__main__":
    app.run(host="0.0.0.0", port=8000)

• 使用注意事项：
  • 本地HTTP服务需要有公网可访问的地址，无固定公网IP可通过内网穿透工具实现
  • 必须配置Webhook签名校验，避免接口被恶意访问触发异常操作
  • 同步前同样需要检查本地未提交改动，避免pull操作冲突失败。

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