Azure DevOps中能否强制为指定仓库集添加含特定Wiki链接的README文件？

一、为新仓库自动添加通用README #

方法1：使用仓库模板（推荐） #

• 创建一个模板仓库，将包含Wiki链接的通用README.md放在仓库根目录
• 进入Azure DevOps组织/项目设置，找到仓库模板选项，将该模板设为组织/项目的默认模板
• 可选：在模板仓库的主分支设置分支策略，添加README.md的文件路径保护，确保后续基于模板创建的仓库无法随意删除或修改该文件

方法2：用Pipeline自动触发 #

• 创建一个Pipeline，配置触发器监听组织内新仓库的创建事件（或定期扫描新增仓库）
• 在Pipeline中使用Azure CLI命令完成仓库操作：

  # 克隆目标新仓库
  git clone $(repoUrl)
  cd $(repoName)
  # 复制通用README到仓库（可提前将README存在Pipeline的安全文件或共享存储中）
  cp ./shared-resources/README.md .
  git add README.md
  git commit -m "Add mandatory README with Wiki links"
  git push origin main
  

二、为现有仓库批量导入通用README #

方法1：Azure CLI + 脚本批量处理 #

1. 先导出组织/项目下的所有仓库列表：

   az repos list --org https://dev.azure.com/your-org --project your-project --output tsv --query "[].remoteUrl" > repos.txt
   

2. 编写Bash/PowerShell脚本遍历仓库列表，逐个添加README：
   示例Bash脚本：

   # 通用README的本地路径
   GENERIC_README="/local/path/to/your/README.md"
   # 遍历仓库列表
   while read REPO_URL; do
       REPO_NAME=$(basename "$REPO_URL" .git)
       # 克隆仓库
       git clone "$REPO_URL"
       cd "$REPO_NAME"
       # 复制README，若已存在则覆盖（根据需求调整）
       cp "$GENERIC_README" .
       # 提交推送
       if git diff --quiet README.md; then
           echo "README already up to date in $REPO_NAME"
       else
           git add README.md
           git commit -m "Update README with mandatory Wiki links"
           git push origin main
       fi
       cd ..
       rm -rf "$REPO_NAME"
   done < repos.txt
   

3. 注意：运行脚本的账号需要有所有仓库的推送权限，若仓库有分支策略限制，需临时调整策略后再执行

方法2：通过REST API批量上传 #

使用Azure DevOps REST API的Repositories - Create Push接口，直接将README文件上传到每个仓库的主分支，无需本地克隆，适合大规模仓库场景。核心请求示例：

POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pushes?api-version=7.1-preview.1
Content-Type: application/json

{
  "refUpdates": [
    {
      "name": "refs/heads/main",
      "oldObjectId": "<当前分支的commit ID>"
    }
  ],
  "commits": [
    {
      "comment": "Add mandatory README with Wiki links",
      "changes": [
        {
          "changeType": "add",
          "item": {
            "path": "/README.md"
          },
          "newContent": {
            "content": "<你的通用README内容（含Wiki链接）>",
            "contentType": "rawtext"
          }
        }
      ]
    }
  ]
}

三、强制保留README的策略设置 #

为了防止README被删除或随意修改，可在仓库主分支添加分支策略：

• 进入仓库的分支策略设置，选择主分支
• 添加文件路径限制，指定README.md为受保护文件，禁止删除或修改
• 可选：添加构建验证或审批要求，确保任何对README的修改都需要经过审核

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