如何配置Azure Pipelines实现Azure DevOps与GitHub仓库自动同步及认证

我们公司以Azure DevOps Repository作为主源代码控制仓库，另有一个外部团队管理的GitHub Repository，结构如下：

• Azure DevOps Repository：包含Source/English.json和Source/German.json文件
• GitHub Repository：包含WorkingFolder/English.json和WorkingFolder/German.json文件

其中English.json由我方维护，GitHub中的German.json由外部团队基于我方更新的English.json完成翻译后更新。

当前手动工作流：

1. 手动更新Azure DevOps中的English.json
2. 手动将相同更新同步至GitHub的English.json
3. 外部团队在GitHub中更新German.json的翻译内容
4. 手动将GitHub的German.json同步至Azure DevOps，需持续手动检查更新

目标是通过Azure Pipelines和GitHub Action实现自动化流程：

• Azure DevOps中English.json变更时，自动推送至GitHub
• GitHub中German.json变更时，自动拉取至Azure DevOps

我尝试创建了如下Azure YAML Pipeline：

trigger:
  branches:
    include:
      - workingBranch
  paths:
    include:
      - Source/English.json

variables:
  branchName: 'workingBranch'

pool:
  vmImage: 'ubuntu-latest'

steps:
- checkout: self
  displayName: 'Checkout Azure DevOps Repository'
  ref: ${{ variables.branchName }}

- script: |
    git clone https://$(GITHUB_PAT)@github.com/your-org/GitTranslationRepo.git
    cd GitTranslationRepo
    git checkout development
    cp ../Source/English.json WorkingFolder/English.json
    git config user.name "your-username"
    git config user.email "your-email"
    git add WorkingFolder/English.json
    git commit -m "Add English.json from Azure DevOps for testing"
    git push origin development
  displayName: 'Sync English.json to GitHub development branch'
  env:
    GITHUB_PAT: $(GITHUB_PAT)

遇到认证错误：fatal: could not read Username for 'https://github.com': terminal prompts disabled.，已创建GitHub PAT并存储为Azure DevOps密钥，尝试在脚本中直接使用PAT认证。

现提出两个问题：

1. 如何正确配置管道，使用PAT或服务连接实现与GitHub的认证？
2. 有没有更优的方案来自动化Azure DevOps与GitHub仓库之间的同步流程？

问题1：正确配置认证方式 #

方式一：修复PAT的Git克隆格式 #

你当前的克隆URL格式有误，正确的带PAT的认证格式需要将PAT作为用户名，密码部分填x-oauth-basic，修改后的克隆命令如下：

git clone https://$(GITHUB_PAT):x-oauth-basic@github.com/your-org/GitTranslationRepo.git

如果已经克隆了仓库，也可以通过修改远程URL注入认证信息：

git clone https://github.com/your-org/GitTranslationRepo.git
cd GitTranslationRepo
git remote set-url origin https://$(GITHUB_PAT):x-oauth-basic@github.com/your-org/GitTranslationRepo.git

这样就能跳过终端的用户名输入提示，直接完成认证。

方式二：使用Azure DevOps GitHub服务连接（更安全） #

1. 进入Azure DevOps项目的项目设置 > 服务连接 > 新建服务连接，选择GitHub类型
2. 选择「使用个人访问令牌」，填入已创建的GitHub PAT，设置服务连接名称（比如GitHub-Translation-Repo）后完成创建
3. 在Pipeline中用checkout任务拉取GitHub仓库，替代手动克隆：

- checkout: git://your-org/GitTranslationRepo@development
  displayName: 'Checkout GitHub Repository'
  persistCredentials: true
  endpoint: 'GitHub-Translation-Repo'

这种方式不需要在脚本中暴露PAT，Azure DevOps会自动处理认证，安全性更高。

问题2：更优的双向同步方案 #

方案一：分方向的自动化同步 #

Azure DevOps → GitHub（English.json同步）

保留原有的触发规则（监听Source/English.json变更），优化执行步骤：

• 用服务连接拉取GitHub仓库，避免认证问题
• 添加文件对比逻辑，只有内容确实变化时才提交，避免空提交：

- script: |
    cd GitTranslationRepo
    # 对比文件内容，仅当不同时执行同步
    if ! diff ../Source/English.json WorkingFolder/English.json > /dev/null; then
      cp ../Source/English.json WorkingFolder/English.json
      git config user.name "Azure DevOps Pipeline"
      git config user.email "devops@yourcompany.com"
      git add WorkingFolder/English.json
      git commit -m "Sync English.json from Azure DevOps [skip ci]"
      git push origin development
    fi
  displayName: 'Sync English.json to GitHub if changed'

GitHub → Azure DevOps（German.json同步）

在GitHub仓库中创建GitHub Action，监听WorkingFolder/German.json的变更：

name: Sync German.json to Azure DevOps
on:
  push:
    paths:
      - 'WorkingFolder/German.json'
    branches:
      - development

jobs:
  sync-to-ado:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Sync to Azure DevOps
        run: |
          # 克隆Azure DevOps仓库，使用Azure DevOps PAT认证
          git clone https://${{ secrets.AZURE_DEVOPS_PAT }}@dev.azure.com/your-org/your-project/_git/your-repo
          cd your-repo
          git checkout workingBranch
          # 文件对比，避免空提交
          if ! diff ../WorkingFolder/German.json Source/German.json > /dev/null; then
            cp ../WorkingFolder/German.json Source/German.json
            git config user.name "GitHub Action"
            git config user.email "github-action@yourcompany.com"
            git add Source/German.json
            git commit -m "Sync German.json from GitHub [skip ci]"
            git push origin workingBranch
          fi
        env:
          AZURE_DEVOPS_PAT: ${{ secrets.AZURE_DEVOPS_PAT }}

需要在GitHub仓库的Settings > Secrets and variables > Actions中添加Azure DevOps的PAT作为密钥AZURE_DEVOPS_PAT。

方案二：仓库级镜像/子模块（复杂场景适配） #

如果后续需要同步的文件或目录更多，可以考虑：

• 将GitHub仓库作为Azure DevOps仓库的子模块，但需要额外配置子模块的更新触发逻辑
• 使用Azure Repos的镜像功能，实现仓库级的双向同步，但需要调整目录结构来匹配双方的文件路径

额外优化建议 #

• 提交信息中加入[skip ci]，避免触发对方仓库的不必要Pipeline
• 脚本中添加set -e，确保同步失败时Pipeline及时报错终止
• 可添加通知步骤（如Slack、邮件），同步成功/失败时通知相关人员

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