如何使用GitPython配合SSH密钥执行git push操作？

实现方案 #

GIT_SSH环境变量的作用是指定Git执行SSH连接时调用的客户端命令，你已经拼接好的ssh -i 密钥路径就是符合要求的参数，作用是告诉SSH程序自动加载指定路径的私钥做验证。你只需要在执行push操作前将该命令注入到Git命令的执行环境中即可，同时你原有代码存在一处逻辑错误：repo.remote(name=branch)的入参是远端仓库的名称（通常默认是origin），不是分支名，需要修正。

步骤1：修改push函数代码

""" Execute Git Push with GitPython Library. """
def push(self, repo_path, branch, commit_message, user):
    repo = Repo(repo_path)
    repo.git.add('--all')
    repo.git.commit('-m', commit_message)
    # 修正：获取默认远端origin，不是按分支名取remote
    origin = repo.remote(name='origin')
    # 注入SSH命令到环境变量后执行push
    with repo.git.custom_environment(GIT_SSH=self.GIT_SSH_CMD):
        origin.push(branch)

步骤2：可选优化项

• 如果你的SSH密钥设置了密码，需要避免交互验证的话，可以修改SSH命令关闭密码提示，避免程序卡住：

# 初始化部分修改GIT_SSH_CMD，添加-o BatchMode=yes参数禁止交互输入密码
self.GIT_SSH_CMD = f"ssh -o BatchMode=yes -i {self.GIT_SSH_KEY}"

• 如果你需要统一配置全局的Git SSH命令，不想每次push都加环境变量，可以在初始化Repo的时候就指定环境：

# 初始化部分修改Repo初始化逻辑
self.REPO = Repo(self.REPO_PATH)
self.REPO.git.update_environment(GIT_SSH=self.GIT_SSH_CMD)

这种情况下push函数就不需要再额外加custom_environment的上下文了，直接调用origin.push(branch)即可生效。

注意事项

• 确保你使用的SSH密钥路径有权限被当前运行程序的用户读取，密钥文件权限建议设置为600，避免SSH因权限问题拒绝加载密钥
• 确保远端仓库的地址是SSH格式（git@xxx.com:xxx/xxx.git），如果是HTTPS格式的远端地址，SSH配置不会生效

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