# 更新 PR 描述 ## 概述 `gh pr edit --body` 可能会在某些 GitHub 实例或配置上静默失败，接受命令但不持久更改。当标准 CLI 工具无法按预期工作时，GitHub REST API 提供可靠的后备方案。 ## 何时使用 * `gh pr edit --body` 接受命令，但更改不会持续（静默失败） * 需要以编程方式更新多行内容的 PR 描述 * 使用复杂的公关模板，其中的编辑内容不会得到反映 * 前进之前需要有保证的坚持 **在以下情况下不需要：** * `gh pr edit --body-file` 成功更新您的 PR * 您只需要更新标题或简单字段 ## 核心模式当 `gh pr edit` 不存在时： # 第 1 步：获取当前 PR 详细信息以验证号码 gh pr 查看 --json 数字 -q '.number' # 第 2 步：首先尝试标准方法 gh pr 编辑 --body "$(cat <<'EOF' 【新正文内容】 EOF ）” # 步骤 3：如果没有错误但更改不持久，则直接使用 API gh api repos/OWNER/REPO/pulls/ -X PATCH -f body="$(cat <<'EOF' 【新正文内容】 EOF ）” ## 关键模式元素 ### 将heredoc与`<<'EOF'`一起使用（而不是`<<"EOF"`）单引号防止 shell 扩展： # ✅ 正确 - 保留反引号、$变量、特殊字符 gh api repos/owner/repo/pulls/123 -X PATCH -f body="$(cat <<'EOF' 包含“反引号”和$特殊字符 EOF ）” # ❌ 错误 - shell 在 API 调用之前扩展变量 gh api repos/owner/repo/pulls/123 -X PATCH -f body="$(cat <<"EOF" 包含“反引号”和 $special（展开！） EOF ）” ### 如果未知则获取 PR 号码 # 来自当前分支（如果跟踪远程 PR） gh pr 查看 --json 数字 -q '.number' ### 验证API调用是否成功检查返回的 JSON 包含您的正文： gh api repos/owner/repo/pulls/123 -X PATCH -f body="新内容" | grep -q "新内容" && echo "成功" ## 实施 ### 简单更新 PR_NUMBER=$(gh pr 查看 --json 数字 -q '.number') gh api repos/Reckon-Limited/reckon-frontend/pulls/$PR_NUMBER -X PATCH -f body="$(cat <<'EOF' # 总结此 PR 实现了功能 X。 ## 特点 - 特征A - 特征B # 测试 EOF ）” ### 更新并验证 PR_NUMBER=$(gh pr 查看 --json 数字 -q '.number') NEW_BODY="# 摘要此 PR 实施员工名单行动。” gh api 存储库/Reckon-Limited/reckon-frontend/pulls/$PR_NUMBER -X PATCH -f body="$NEW_BODY" # 通过检查返回的正文匹配来验证 gh pr 查看 $PR_NUMBER --json body -q '.body' |头-1 ## 常见错误 **错误 1：对 Heredoc 使用错误的引用** # ❌ 错误 - 变量扩展，破坏格式 gh api repos/owner/repo/pulls/123 -X PATCH -f body="$(cat <<"EOF" 像 $VAR 和 $(commands) 这样的变量将会扩展 EOF ）” # ✅ 正确 gh api repos/owner/repo/pulls/123 -X PATCH -f body="$(cat <<'EOF' 像 $VAR 和 $(commands) 这样的变量保持原义 EOF ）” **错误2：在假设成功之前不检查返回值** # ❌ 命令返回 200 但更改不会持续 gh pr edit 123 --body "new content" # 退出0，无错误 # ✅ 使用 API 并检查响应 gh api repos/owner/repo/pulls/123 -X PATCH -f body="新内容" | grep -q “新内容” **错误 3：忘记`--body-file` 作为中间步骤** # ✅ 最佳实践顺序： # 1. 尝试 gh pr edit --body-file （基于文件，比内联更可靠） # 2. 如果失败，请使用 gh api （始终有效） gh pr edit 123 --body-file my_body.md # 首先尝试这个 **错误 4：使用特殊字符错误地构建正文字符串** # ❌ 错误 - 换行符丢失，特殊字符导致问题 BODY="#摘要\n新内容" gh api repos/owner/repo/pulls/123 -X PATCH -f body="$BODY" # ✅ 正确 - 使用heredoc 保留格式 gh api repos/owner/repo/pulls/123 -X PATCH -f body="$(cat <<'EOF' # 总结新内容 EOF ）” ## 故障排除 **如果 API 调用返回 422 Unprocessable Entity:** * 检查 PR 编号是否正确：`gh pr view --json number` * 检查存储库路径（OWNER/REPO）： `gh api repos/Reckon-Limited/reckon-frontend --json nameWithOwner` * 验证身份验证：`gh auth status` **如果正文更新但包含转义换行符或格式问题：** * 使用带单引号的heredoc：`<<'EOF'`而不是`<<"EOF"` * 避免复杂内容的内联字符串 - 使用heredoc **如果命令成功但`gh pr view`显示旧的正文：** * 稍等一下（GitHub API 最终一致性） * 清除所有本地缓存：`gh pr view --refresh` * 通过 GitHub Web UI 验证（浏览器可能会缓存） ## 现实世界的影响当“gh pr edit”无提示失败时使用 API 回退可确保在自动化脚本中可靠地更新 PR 描述，减少手动后续工作并确保审阅者获得准确的 PR 文档。

公关说明

包含技能