寻求可编辑GitHub PR描述或调用GitHub API的TeamCity Runner

一、现成Runner选项 #

1. GitHub PR Description Editor（社区插件） #

这款TeamCity Runner专门针对PR描述编辑场景，支持直接追加/替换PR内容，可直接引用TeamCity内置参数（如工件链接%teamcity.build.artifactsUrl%）。配置时只需提供：

• GitHub认证令牌（PAT）
• PR编号（可通过TeamCity自动注入的%github.pr.number%参数获取）
• 要追加的内容模板（比如固定格式的工件链接区块）

2. 官方GitHub Integration Plugin的通用API调用能力 #

安装JetBrains官方GitHub插件后，可通过Command Line或Script构建步骤间接实现API调用：插件会自动注入GitHub认证信息，无需手动处理令牌的传递，简化了调用流程。

二、自定义实现（灵活度更高） #

如果找不到完全匹配的现成Runner，直接用脚本实现是更可靠的方案：

方式1：Command Line + GitHub CLI #

1. 在TeamCity项目配置中添加GitHub PAT作为加密参数（如%github.pat%），权限需勾选repo（私有仓库）或public_repo（公有仓库）。
2. 添加Command Line构建步骤，执行以下脚本（支持增量更新，避免重复追加）：

   # 获取当前PR的原始描述
   PR_DESCRIPTION=$(gh pr view %github.pr.number% --json body --jq '.body')
   
   # 定义工件链接区块（带标记避免重复）
   ARTIFACT_BLOCK="\n\n<!-- TEAMCITY_ARTIFACTS -->
   ### 构建工件链接
   [%teamcity.build.number% 构建工件](%teamcity.build.artifactsUrl%)
   <!-- END_TEAMCITY_ARTIFACTS -->"
   
   # 检查是否已有工件区块，有则替换，无则追加
   if echo "$PR_DESCRIPTION" | grep -q "<!-- TEAMCITY_ARTIFACTS -->"; then
       UPDATED_DESCRIPTION=$(echo "$PR_DESCRIPTION" | sed 's/<!-- TEAMCITY_ARTIFACTS -->.*<!-- END_TEAMCITY_ARTIFACTS -->/'"${ARTIFACT_BLOCK}"'/g')
   else
       UPDATED_DESCRIPTION="${PR_DESCRIPTION}${ARTIFACT_BLOCK}"
   fi
   
   # 更新PR描述
   gh pr edit %github.pr.number% --body "$UPDATED_DESCRIPTION"
   

方式2：Script + curl直接调用GitHub API #

无需安装GitHub CLI，直接用curl发起API请求：

# 解析仓库名（从TeamCity VCS根参数获取）
REPO_FULL_NAME=$(echo %vcsroot.url% | sed 's/.*github.com\/\(.*\)\.git/\1/')

# 获取原始PR描述
PR_DESCRIPTION=$(curl -s -H "Authorization: token %github.pat%" "https://api.github.com/repos/${REPO_FULL_NAME}/pulls/%github.pr.number%" | jq -r '.body')

# 构建更新后的描述（逻辑同方式1）
ARTIFACT_BLOCK="\n\n<!-- TEAMCITY_ARTIFACTS -->
### 构建工件链接
[%teamcity.build.number% 构建工件](%teamcity.build.artifactsUrl%)
<!-- END_TEAMCITY_ARTIFACTS -->"

if echo "$PR_DESCRIPTION" | grep -q "<!-- TEAMCITY_ARTIFACTS -->"; then
    UPDATED_DESCRIPTION=$(echo "$PR_DESCRIPTION" | sed 's/<!-- TEAMCITY_ARTIFACTS -->.*<!-- END_TEAMCITY_ARTIFACTS -->/'"${ARTIFACT_BLOCK}"'/g')
else
    UPDATED_DESCRIPTION="${PR_DESCRIPTION}${ARTIFACT_BLOCK}"
fi

# 发送更新请求
curl -X PATCH -H "Authorization: token %github.pat%" \
     -H "Accept: application/vnd.github.v3+json" \
     "https://api.github.com/repos/${REPO_FULL_NAME}/pulls/%github.pr.number%" \
     -d "{\"body\":\"${UPDATED_DESCRIPTION}\"}"

三、核心配置要点 #

• 认证令牌权限：必须包含repo（私有仓库）或public_repo（公有仓库）权限，确保能修改PR内容。
• 参数依赖：%github.pr.number%需要官方GitHub插件注入，若未安装插件，可通过TeamCity的VCS分支名解析PR编号（比如从refs/pull/123/head提取123）。
• 避免重复：通过添加注释标记<!-- TEAMCITY_ARTIFACTS -->，确保每次构建只更新工件链接，不会重复追加内容。

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