pr_format_bot.yml 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141
  1. name: PR Format Notification
  2. on:
  3. pull_request_target:
  4. types: [opened]
  5. concurrency:
  6. group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  7. cancel-in-progress: true
  8. permissions:
  9. pull-requests: write
  10. contents: read
  11. jobs:
  12. notify-format:
  13. if: github.repository_owner == 'RT-Thread'
  14. runs-on: ubuntu-latest
  15. steps:
  16. - name: Check if first commit and add comment
  17. env:
  18. GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  19. run: |
  20. echo "Event action: ${{ github.event.action }}"
  21. # 获取 PR 的提交信息
  22. commits=$(curl -s \
  23. -H "Accept: application/vnd.github.v3+json" \
  24. -H "Authorization: Bearer $GITHUB_TOKEN" \
  25. "https://api.github.com/repos/${{ github.repository }}/pulls/${{ github.event.pull_request.number }}/commits")
  26. # 检查 API 响应是否为数组
  27. if echo "$commits" | jq -e 'type == "array"' > /dev/null; then
  28. commit_count=$(echo "$commits" | jq '. | length')
  29. echo "PR commit count: $commit_count"
  30. should_comment=false
  31. if [ "${{ github.event.action }}" = "opened" ]; then
  32. should_comment=true
  33. elif [ "${{ github.event.action }}" = "synchronize" ] && [ "$commit_count" -eq 1 ]; then
  34. should_comment=true
  35. fi
  36. if [ "$should_comment" = true ]; then
  37. echo "Adding format notification comment..."
  38. # 构建工作流链接
  39. branch="${{ github.event.pull_request.head.ref }}"
  40. fork_repo="${{ github.event.pull_request.head.repo.full_name }}"
  41. workflow_url="https://github.com/${fork_repo}/actions/workflows/pr_clang_format.yml"
  42. direct_link="${workflow_url}?branch=${branch}"
  43. # 使用数组存储多行消息
  44. message_lines=(
  45. "<!-- PR Format Notification Comment -->"
  46. "**👋 感谢您对 RT-Thread 的贡献!Thank you for your contribution to RT-Thread!**"
  47. ""
  48. "为确保代码符合 RT-Thread 的编码规范,请在你的仓库中执行以下步骤运行代码格式化工作流(如果格式化CI运行失败)。"
  49. "To ensure your code complies with RT-Thread's coding style, please run the code formatting workflow by following the steps below (If the formatting of CI fails to run)."
  50. ""
  51. "---"
  52. ""
  53. "### 🛠 操作步骤 | Steps"
  54. ""
  55. "1. **前往 Actions 页面 | Go to the Actions page**"
  56. "[点击进入工作流 → | Click to open workflow →](${direct_link})"
  57. ""
  58. "2. **点击 \`Run workflow\` | Click \`Run workflow\`**"
  59. "- 设置需排除的文件/目录(目录请以\"/\"结尾)"
  60. "Set files/directories to exclude (directories should end with \"/\")"
  61. "- 将目标分支设置为 \ Set the target branch to:**\`${branch}\`**"
  62. "- 设置PR number为 \ Set the PR number to:**\`${{ github.event.pull_request.number }}\`**"
  63. ""
  64. "3. **等待工作流完成 | Wait for the workflow to complete**"
  65. "格式化后的代码将自动推送至你的分支。"
  66. "The formatted code will be automatically pushed to your branch."
  67. ""
  68. "完成后,提交将自动更新至 \`${branch}\` 分支,关联的 Pull Request 也会同步更新。"
  69. "Once completed, commits will be pushed to the \`${branch}\` branch automatically, and the related Pull Request will be updated."
  70. ""
  71. "如有问题欢迎联系我们,再次感谢您的贡献!💐"
  72. "If you have any questions, feel free to reach out. Thanks again for your contribution!"
  73. )
  74. # 拼接数组为多行字符串
  75. message=$(printf "%s\n" "${message_lines[@]}")
  76. echo "Message content:"
  77. echo "$message"
  78. # 查找现有的 bot 评论
  79. existing_comment=$(curl -s \
  80. -H "Accept: application/vnd.github.v3+json" \
  81. -H "Authorization: Bearer $GITHUB_TOKEN" \
  82. "https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.pull_request.number }}/comments" | \
  83. jq -r '.[] | select(.user.login == "github-actions[bot]" and (.body | contains("<!-- PR Format Notification Comment -->"))) | {id: .id, body: .body} | @base64')
  84. # 使用 jq 安全地构建 JSON 负载
  85. json_payload=$(jq -n --arg body "$message" '{"body": $body}')
  86. if [[ -n "$existing_comment" ]]; then
  87. # 更新现有评论
  88. comment_id=$(echo "$existing_comment" | head -1 | base64 -d | jq -r .id)
  89. echo "Updating existing comment $comment_id"
  90. response=$(curl -s -w "\n%{http_code}" \
  91. -X PATCH \
  92. -H "Accept: application/vnd.github.v3+json" \
  93. -H "Authorization: Bearer $GITHUB_TOKEN" \
  94. -d "$json_payload" \
  95. "https://api.github.com/repos/${{ github.repository }}/issues/comments/$comment_id")
  96. else
  97. # 创建新评论
  98. echo "Creating new comment"
  99. response=$(curl -s -w "\n%{http_code}" \
  100. -X POST \
  101. -H "Accept: application/vnd.github.v3+json" \
  102. -H "Authorization: Bearer $GITHUB_TOKEN" \
  103. -d "$json_payload" \
  104. "https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.pull_request.number }}/comments")
  105. fi
  106. # 提取 HTTP 状态码和响应体
  107. http_code=$(echo "$response" | tail -n1)
  108. response_body=$(echo "$response" | sed '$d')
  109. if [ "$http_code" -eq 201 ] || [ "$http_code" -eq 200 ]; then
  110. echo "Format notification comment added/updated successfully"
  111. echo "Comment URL: $(echo "$response_body" | jq -r '.html_url')"
  112. else
  113. echo "Failed to add/update comment. HTTP status: $http_code"
  114. echo "Response: $response_body"
  115. exit 1
  116. fi
  117. else
  118. echo "Not the first commit, skipping comment"
  119. fi
  120. else
  121. echo "Failed to get commits from GitHub API"
  122. echo "Response: $commits"
  123. exit 1
  124. fi