-
Notifications
You must be signed in to change notification settings - Fork 3.8k
[chore](ci) refactor code review workflow to run on PR events with comment-triggered dispatch #62369
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
[chore](ci) refactor code review workflow to run on PR events with comment-triggered dispatch #62369
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| name: Code Review Comment Dispatch | ||
|
|
||
| on: | ||
| issue_comment: | ||
| types: [created] | ||
|
|
||
| permissions: | ||
| statuses: write | ||
| pull-requests: write | ||
| contents: read | ||
| issues: write | ||
|
|
||
| jobs: | ||
| resolve-pr: | ||
| runs-on: ubuntu-latest | ||
| if: >- | ||
| github.event.issue.pull_request && | ||
| contains(github.event.comment.body, '/review') | ||
|
zclllyybb marked this conversation as resolved.
zclllyybb marked this conversation as resolved.
|
||
| outputs: | ||
| pr_number: ${{ steps.pr.outputs.pr_number }} | ||
| head_sha: ${{ steps.pr.outputs.head_sha }} | ||
| base_sha: ${{ steps.pr.outputs.base_sha }} | ||
| steps: | ||
| - name: Get PR info | ||
| id: pr | ||
| env: | ||
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| run: | | ||
| PR_JSON=$(gh api repos/${{ github.repository }}/pulls/${{ github.event.issue.number }}) | ||
| HEAD_SHA=$(echo "$PR_JSON" | jq -r '.head.sha') | ||
| BASE_SHA=$(echo "$PR_JSON" | jq -r '.base.sha') | ||
| echo "pr_number=${{ github.event.issue.number }}" >> "$GITHUB_OUTPUT" | ||
| echo "head_sha=$HEAD_SHA" >> "$GITHUB_OUTPUT" | ||
| echo "base_sha=$BASE_SHA" >> "$GITHUB_OUTPUT" | ||
|
|
||
| code-review: | ||
| needs: | ||
| - resolve-pr | ||
| - mark-review-pending | ||
| if: >- | ||
| github.event.issue.pull_request && | ||
| contains(github.event.comment.body, '/review') | ||
| uses: ./.github/workflows/opencode-review-runner.yml | ||
| secrets: inherit | ||
| with: | ||
|
zclllyybb marked this conversation as resolved.
|
||
| pr_number: ${{ needs.resolve-pr.outputs.pr_number }} | ||
| head_sha: ${{ needs.resolve-pr.outputs.head_sha }} | ||
| base_sha: ${{ needs.resolve-pr.outputs.base_sha }} | ||
|
|
||
| mark-review-pending: | ||
| needs: resolve-pr | ||
| runs-on: ubuntu-latest | ||
| if: >- | ||
| github.event.issue.pull_request && | ||
| contains(github.event.comment.body, '/review') | ||
| steps: | ||
| - name: Mark Code Review status as pending | ||
| env: | ||
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| REPO: ${{ github.repository }} | ||
| HEAD_SHA: ${{ needs.resolve-pr.outputs.head_sha }} | ||
| run: | | ||
| gh api repos/${REPO}/statuses/${HEAD_SHA} \ | ||
| -X POST \ | ||
| -f state='pending' \ | ||
| -f context='code-review' \ | ||
| -f description="Automated review is running for ${HEAD_SHA}." \ | ||
| -f target_url="${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}" | ||
|
|
||
| refresh-required-check: | ||
| needs: | ||
| - resolve-pr | ||
| - code-review | ||
| runs-on: ubuntu-latest | ||
| if: ${{ always() && needs.resolve-pr.result == 'success' && needs.code-review.result != 'skipped' }} | ||
| steps: | ||
| - name: Sync Code Review check for current head | ||
| env: | ||
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| REPO: ${{ github.repository }} | ||
| PR_NUMBER: ${{ needs.resolve-pr.outputs.pr_number }} | ||
| HEAD_SHA: ${{ needs.resolve-pr.outputs.head_sha }} | ||
| run: | | ||
| REVIEWS=$(gh api --paginate repos/${REPO}/pulls/${PR_NUMBER}/reviews) | ||
| review_state=$(printf '%s' "$REVIEWS" | jq -r --arg head_sha "$HEAD_SHA" ' | ||
| ([ .[] | ||
| | select(.user.login == "github-actions[bot]" or .user.login == "github-actions") | ||
| | select(.commit_id == $head_sha) | ||
| | select(.state == "APPROVED" or .state == "CHANGES_REQUESTED") | ||
| ] | ||
| | sort_by(.submitted_at) | ||
| | last | ||
| | .state) // "" | ||
| ') | ||
|
|
||
| conclusion="failure" | ||
| summary="No automated approve/request-changes review exists for ${HEAD_SHA}." | ||
|
|
||
| if [ "$review_state" = "APPROVED" ]; then | ||
| conclusion="success" | ||
| summary="Automated review approved the PR for ${HEAD_SHA}." | ||
| elif [ "$review_state" = "CHANGES_REQUESTED" ]; then | ||
| summary="Automated review requested changes for ${HEAD_SHA}." | ||
| fi | ||
|
|
||
| state="failure" | ||
| [ "$conclusion" = "success" ] && state="success" | ||
|
|
||
| gh api repos/${REPO}/statuses/${HEAD_SHA} \ | ||
| -X POST \ | ||
| -f state="${state}" \ | ||
| -f context='code-review' \ | ||
| -f description="${summary}" \ | ||
| -f target_url="${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}" | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,199 @@ | ||
| name: Code Review Runner | ||
|
|
||
| on: | ||
| workflow_call: | ||
| inputs: | ||
| pr_number: | ||
| required: true | ||
| type: string | ||
| head_sha: | ||
| required: true | ||
| type: string | ||
| base_sha: | ||
| required: true | ||
| type: string | ||
|
|
||
| permissions: | ||
| pull-requests: write | ||
| contents: read | ||
| issues: write | ||
|
|
||
| jobs: | ||
| code-review: | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 60 | ||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| ref: ${{ inputs.head_sha }} | ||
|
|
||
| - name: Install ripgrep | ||
| run: | | ||
| sudo apt-get update | ||
| sudo apt-get install -y ripgrep | ||
|
|
||
| - name: Install OpenCode | ||
| run: | | ||
| for attempt in 1 2 3; do | ||
| if curl -fsSL https://opencode.ai/install | bash; then | ||
| echo "$HOME/.opencode/bin" >> $GITHUB_PATH | ||
| exit 0 | ||
| fi | ||
| echo "Install attempt $attempt failed, retrying in 10s..." | ||
| sleep 10 | ||
| done | ||
| echo "All install attempts failed" | ||
| exit 1 | ||
|
|
||
| - name: Configure OpenCode auth | ||
| run: | | ||
| mkdir -p ~/.local/share/opencode | ||
| cat > ~/.local/share/opencode/auth.json <<EOF | ||
| { | ||
| "github-copilot": { | ||
| "type": "oauth", | ||
| "refresh": "${CODE_REVIEW_ZCLLL_COPILOT_OPENCODE_KEY}", | ||
| "access": "${CODE_REVIEW_ZCLLL_COPILOT_OPENCODE_KEY}", | ||
| "expires": 0 | ||
| } | ||
| } | ||
| EOF | ||
| env: | ||
| CODE_REVIEW_ZCLLL_COPILOT_OPENCODE_KEY: ${{ secrets.CODE_REVIEW_ZCLLL_COPILOT_OPENCODE_KEY }} | ||
|
|
||
| - name: Configure OpenCode permission | ||
| run: | | ||
| echo '{"permission":"allow"}' > opencode.json | ||
|
|
||
| - name: Prepare review prompt | ||
| run: | | ||
| cat > /tmp/review_prompt.txt <<'PROMPT' | ||
| You are performing an automated code review inside a GitHub Actions runner. The gh CLI is available and authenticated via GH_TOKEN. You can comment on the pull request. | ||
|
|
||
| Context: | ||
| - Repository: PLACEHOLDER_REPO | ||
| - PR number: PLACEHOLDER_PR_NUMBER | ||
| - PR Head SHA: PLACEHOLDER_HEAD_SHA | ||
| - PR Base SHA: PLACEHOLDER_BASE_SHA | ||
|
|
||
| Before reviewing any code, you MUST read and follow the code review skill in this repository. During review, you must strictly follow those instructions. | ||
|
zclllyybb marked this conversation as resolved.
|
||
| In addition, you can perform any desired review operations to observe suspicious code and details in order to identify issues as much as possible. | ||
|
|
||
| ## Final response format | ||
| - After completing the review, you MUST provide a final summary opinion based on the rules defined in AGENTS.md and the code-review skill. The summary must include conclusions for each applicable critical checkpoint. | ||
| - If the overall quality of PR is good and there are no critical blocking issues (even if there are some tolerable minor issues), submit an opinion on approval using: gh pr review PLACEHOLDER_PR_NUMBER --approve --body "<summary>" | ||
| - If issues found, submit a review with inline comments plus a comprehensive summary body. Use GitHub Reviews API to ensure comments are inline: | ||
| - Inline comment bodies may include GitHub suggested changes blocks when you can propose a precise patch. | ||
| - Prefer suggested changes for small, self-contained fixes (for example typos, trivial refactors, or narrowly scoped code corrections). | ||
| - Do not force suggested changes for broad, architectural, or multi-file issues; explain those normally. | ||
| - Build a JSON array of comments like: [{ "path": "<file>", "position": <diff_position>, "body": "..." }] | ||
| - Submit via: gh api repos/PLACEHOLDER_REPO/pulls/PLACEHOLDER_PR_NUMBER/reviews --input <json_file> | ||
| - The JSON file should contain: {"event":"REQUEST_CHANGES","body":"<summary>","comments":[...]} | ||
| - After publish your opinion, your final response MUST end with exactly one machine-readable result block in this format: | ||
| RESULT_START | ||
| { | ||
| "decision": "APPROVE" | "REQUEST_CHANGES" | ||
| } | ||
| RESULT_END | ||
| PROMPT | ||
| sed -i "s|PLACEHOLDER_REPO|${REPO}|g" /tmp/review_prompt.txt | ||
| sed -i "s|PLACEHOLDER_PR_NUMBER|${PR_NUMBER}|g" /tmp/review_prompt.txt | ||
| sed -i "s|PLACEHOLDER_HEAD_SHA|${HEAD_SHA}|g" /tmp/review_prompt.txt | ||
| sed -i "s|PLACEHOLDER_BASE_SHA|${BASE_SHA}|g" /tmp/review_prompt.txt | ||
| env: | ||
| REPO: ${{ github.repository }} | ||
| PR_NUMBER: ${{ inputs.pr_number }} | ||
| HEAD_SHA: ${{ inputs.head_sha }} | ||
| BASE_SHA: ${{ inputs.base_sha }} | ||
|
|
||
| - name: Run automated code review | ||
| id: review | ||
| timeout-minutes: 55 | ||
| continue-on-error: true | ||
| env: | ||
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| run: | | ||
| PROMPT=$(cat /tmp/review_prompt.txt) | ||
|
|
||
| set +e | ||
| opencode run "$PROMPT" -m "github-copilot/gpt-5.4" 2>&1 | tee /tmp/opencode-review.log | ||
| status=${PIPESTATUS[0]} | ||
| set -e | ||
|
|
||
| last_log_line=$(awk 'NF { line = $0 } END { print line }' /tmp/opencode-review.log) | ||
|
|
||
| failure_reason="" | ||
| if printf '%s\n' "$last_log_line" | rg -q -i '^Error:|SSE read timed out'; then | ||
| failure_reason="$last_log_line" | ||
| elif [ "$status" -ne 0 ]; then | ||
| failure_reason="OpenCode exited with status $status" | ||
| fi | ||
|
|
||
| result_json=$(awk ' | ||
| /^RESULT_START$/ {capture=1; current=""; next} | ||
| /^RESULT_END$/ {capture=0; result=current; found=1; next} | ||
| capture {current = current $0 ORS} | ||
| END { | ||
| if (found) { | ||
| printf "%s", result | ||
| } | ||
| } | ||
| ' /tmp/opencode-review.log) | ||
|
|
||
| if [ -z "$failure_reason" ] && [ -z "$result_json" ]; then | ||
| failure_reason="OpenCode did not emit a RESULT_START/RESULT_END result block" | ||
| fi | ||
|
|
||
| if [ -z "$failure_reason" ] && ! printf '%s' "$result_json" > /tmp/opencode-review-result.json; then | ||
| failure_reason="Failed to persist OpenCode review result" | ||
| fi | ||
|
|
||
| if [ -z "$failure_reason" ] && ! jq -e '.decision == "APPROVE" or .decision == "REQUEST_CHANGES"' /tmp/opencode-review-result.json > /dev/null; then | ||
| failure_reason="OpenCode emitted an invalid review decision" | ||
| fi | ||
|
|
||
| if [ -n "$failure_reason" ]; then | ||
| { | ||
| echo "failure_reason<<EOF" | ||
| printf '%s\n' "$failure_reason" | ||
| echo "EOF" | ||
| } >> "$GITHUB_OUTPUT" | ||
| exit 1 | ||
| fi | ||
|
|
||
| decision=$(jq -r '.decision' /tmp/opencode-review-result.json) | ||
| echo "decision=$decision" >> "$GITHUB_OUTPUT" | ||
|
|
||
| if [ "$decision" == "REQUEST_CHANGES" ]; then | ||
| exit 1 | ||
| fi | ||
|
|
||
| - name: Comment PR on review failure | ||
| if: ${{ always() && steps.review.outcome != 'success' && steps.review.outputs.decision != 'REQUEST_CHANGES' }} | ||
| env: | ||
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| REVIEW_FAILURE_REASON: ${{ steps.review.outputs.failure_reason }} | ||
| REVIEW_OUTCOME: ${{ steps.review.outcome }} | ||
| RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} | ||
| run: | | ||
| error_msg="${REVIEW_FAILURE_REASON:-Review step was $REVIEW_OUTCOME (possibly timeout or cancelled)}" | ||
| gh pr comment "${{ inputs.pr_number }}" --body "$(cat <<EOF | ||
| OpenCode automated review failed and did not complete. | ||
|
|
||
| Error: ${error_msg} | ||
| Workflow run: ${RUN_URL} | ||
|
|
||
| Please inspect the workflow logs and rerun the review after the underlying issue is resolved. | ||
| EOF | ||
| )" | ||
|
|
||
| - name: Fail workflow if review failed | ||
| if: ${{ always() && steps.review.outcome != 'success' }} | ||
| env: | ||
| REVIEW_FAILURE_REASON: ${{ steps.review.outputs.failure_reason }} | ||
| REVIEW_OUTCOME: ${{ steps.review.outcome }} | ||
| run: | | ||
| error_msg="${REVIEW_FAILURE_REASON:-Review step was $REVIEW_OUTCOME (possibly timeout or cancelled)}" | ||
| echo "OpenCode automated review failed: ${error_msg}" | ||
| exit 1 | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.