mirror of
https://github.com/Mail-0/Zero.git
synced 2026-06-28 06:46:15 +00:00
Enhance PR review workflow with line-specific comments and reaction indicators (#1958)
# READ CAREFULLY THEN REMOVE Remove bullet points that are not relevant. PLEASE REFRAIN FROM USING AI TO WRITE YOUR CODE AND PR DESCRIPTION. IF YOU DO USE AI TO WRITE YOUR CODE PLEASE PROVIDE A DESCRIPTION AND REVIEW IT CAREFULLY. MAKE SURE YOU UNDERSTAND THE CODE YOU ARE SUBMITTING USING AI. - Pull requests that do not follow these guidelines will be closed without review or comment. - If you use AI to write your PR description your pr will be close without review or comment. - If you are unsure about anything, feel free to ask for clarification. ## Description Please provide a clear description of your changes. --- ## Type of Change Please delete options that are not relevant. - [ ] 🐛 Bug fix (non-breaking change which fixes an issue) - [ ] ✨ New feature (non-breaking change which adds functionality) - [ ] 💥 Breaking change (fix or feature with breaking changes) - [ ] 📝 Documentation update - [ ] 🎨 UI/UX improvement - [ ] 🔒 Security enhancement - [ ] ⚡ Performance improvement ## Areas Affected Please check all that apply: - [ ] Email Integration (Gmail, IMAP, etc.) - [ ] User Interface/Experience - [ ] Authentication/Authorization - [ ] Data Storage/Management - [ ] API Endpoints - [ ] Documentation - [ ] Testing Infrastructure - [ ] Development Workflow - [ ] Deployment/Infrastructure ## Testing Done Describe the tests you've done: - [ ] Unit tests added/updated - [ ] Integration tests added/updated - [ ] Manual testing performed - [ ] Cross-browser testing (if UI changes) - [ ] Mobile responsiveness verified (if UI changes) ## Security Considerations For changes involving data or authentication: - [ ] No sensitive data is exposed - [ ] Authentication checks are in place - [ ] Input validation is implemented - [ ] Rate limiting is considered (if applicable) ## Checklist - [ ] I have read the [CONTRIBUTING](https://github.com/Mail-0/Zero/blob/staging/.github/CONTRIBUTING.md) document - [ ] My code follows the project's style guidelines - [ ] I have performed a self-review of my code - [ ] I have commented my code, particularly in complex areas - [ ] I have updated the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix/feature works - [ ] All tests pass locally - [ ] Any dependent changes are merged and published ## Additional Notes Add any other context about the pull request here. ## Screenshots/Recordings Add screenshots or recordings here if applicable. --- _By submitting this pull request, I confirm that my contribution is made under the terms of the project's license._ <!-- This is an auto-generated description by cubic. --> --- ## Summary by cubic Improved the PR review workflow by adding line-specific comments and reaction indicators to make feedback clearer and easier to track. - **New Features** - Added support for posting review comments on exact lines in changed files. - Added 👀 and ✅ reactions to show when review starts and completes. <!-- End of auto-generated description by cubic. -->
This commit is contained in:
Adam
159
.github/workflows/ampcode-pr-review.yml
vendored
159
.github/workflows/ampcode-pr-review.yml
vendored
@@ -23,7 +23,7 @@ jobs:
|
||||
matrix:
|
||||
review-chunk: [1]
|
||||
max-parallel: 3
|
||||
|
||||
|
||||
steps:
|
||||
- name: Checkout PR branch
|
||||
uses: actions/checkout@v4
|
||||
@@ -57,28 +57,43 @@ jobs:
|
||||
echo "EOF" >> $GITHUB_OUTPUT
|
||||
echo "Changed files count: $(echo "$CHANGED_FILES" | wc -l)"
|
||||
|
||||
- name: Add Review Started Reaction
|
||||
if: steps.changed-files.outputs.changed_files != ''
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: |
|
||||
# Add a reaction to indicate review has started
|
||||
curl -X POST \
|
||||
-H "Authorization: token $GITHUB_TOKEN" \
|
||||
-H "Accept: application/vnd.github.v3+json" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"content":"eyes"}' \
|
||||
"https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.pull_request.number }}/reactions"
|
||||
|
||||
echo "Added 👀 reaction to indicate review has started"
|
||||
|
||||
- name: Run Ampcode Review
|
||||
if: steps.changed-files.outputs.changed_files != ''
|
||||
env:
|
||||
AMP_API_KEY: ${{ secrets.AMPCODE_API_KEY }}
|
||||
run: |
|
||||
echo "Running ampcode review on changed files..."
|
||||
|
||||
|
||||
# Create a temporary file with the changed files list
|
||||
echo "${{ steps.changed-files.outputs.changed_files }}" > changed_files.txt
|
||||
|
||||
# Run ampcode review on the changed files
|
||||
REVIEW_OUTPUT=$(amp -x "Review the following files for code quality, potential bugs, security issues, performance concerns, and best practices. Focus on providing specific, actionable feedback with line numbers when possible. Files to review: $(cat changed_files.txt | tr '\n' ' ')" 2>&1 || echo "Ampcode review failed")
|
||||
|
||||
|
||||
# Run ampcode review on the changed files with specific instructions for line-level feedback
|
||||
REVIEW_OUTPUT=$(amp -x "Review the following files for code quality, potential bugs, security issues, performance concerns, and best practices. For each issue found, provide the specific file path and line number where the issue occurs. Format your response as: FILE:line_number:issue_description. Focus on providing specific, actionable feedback with exact line numbers. Files to review: $(cat changed_files.txt | tr '\n' ' ')" 2>&1 || echo "Ampcode review failed")
|
||||
|
||||
# Save review output to file
|
||||
echo "$REVIEW_OUTPUT" > ampcode_review.txt
|
||||
|
||||
|
||||
# Display review output for debugging
|
||||
echo "=== Ampcode Review Output ==="
|
||||
cat ampcode_review.txt
|
||||
echo "=== End Review Output ==="
|
||||
|
||||
- name: Parse and Post Review Comments
|
||||
- name: Parse and Post Line-Specific Comments
|
||||
if: steps.changed-files.outputs.changed_files != ''
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
@@ -88,39 +103,123 @@ jobs:
|
||||
echo "No review output found or file is empty"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
|
||||
# Read the review output
|
||||
REVIEW_CONTENT=$(cat ampcode_review.txt)
|
||||
|
||||
# Create a comprehensive PR review comment using proper JSON escaping
|
||||
# Use jq to properly escape the review content for JSON
|
||||
ESCAPED_CONTENT=$(echo "$REVIEW_CONTENT" | jq -Rs .)
|
||||
|
||||
# Create the JSON payload with proper escaping
|
||||
jq -n \
|
||||
--arg content "$REVIEW_CONTENT" \
|
||||
--arg run_id "${{ github.run_id }}" \
|
||||
--arg repo "${{ github.repository }}" \
|
||||
'{
|
||||
"body": ("## 🤖 Automated Code Review by Ampcode\n\n**Review Summary:**\n\nI'\''ve analyzed the changes in this PR using AI-powered code review. Here are my findings:\n\n### 📋 Review Results\n\n```\n" + $content + "\n```\n\n### 🔍 Key Areas Reviewed\n- Code quality and best practices\n- Potential bugs and security issues\n- Performance considerations\n- Maintainability and readability\n\n### 📝 Notes\n- This is an automated review generated by Ampcode AI\n- Please review the suggestions and apply them as appropriate\n- For questions about specific recommendations, feel free to ask!\n\n---\n*Generated by [Ampcode](https://ampcode.com) • [View Workflow](https://github.com/" + $repo + "/actions/runs/" + $run_id + ")*"),
|
||||
"event": "COMMENT"
|
||||
}' > review_comment.json
|
||||
|
||||
# Post the review comment
|
||||
|
||||
# Parse the review content for line-specific comments
|
||||
# Look for patterns like "file.ts:123:issue description"
|
||||
echo "$REVIEW_CONTENT" | grep -E '^[^:]+:[0-9]+:' > line_comments.txt || true
|
||||
|
||||
# If no line-specific comments found, create a general comment
|
||||
if [ ! -s line_comments.txt ]; then
|
||||
echo "No line-specific comments found, creating general review comment"
|
||||
|
||||
# Create a general PR review comment
|
||||
jq -n \
|
||||
--arg content "$REVIEW_CONTENT" \
|
||||
--arg run_id "${{ github.run_id }}" \
|
||||
--arg repo "${{ github.repository }}" \
|
||||
'{
|
||||
"body": ("## 🤖 Automated Code Review by Ampcode\n\n**Review Summary:**\n\nI'\''ve analyzed the changes in this PR using AI-powered code review. Here are my findings:\n\n### 📋 Review Results\n\n```\n" + $content + "\n```\n\n### 🔍 Key Areas Reviewed\n- Code quality and best practices\n- Potential bugs and security issues\n- Performance considerations\n- Maintainability and readability\n\n### 📝 Notes\n- This is an automated review generated by Ampcode AI\n- Please review the suggestions and apply them as appropriate\n- For questions about specific recommendations, feel free to ask!\n\n---\n*Generated by [Ampcode](https://ampcode.com) • [View Workflow](https://github.com/" + $repo + "/actions/runs/" + $run_id + ")*"),
|
||||
"event": "COMMENT"
|
||||
}' > review_comment.json
|
||||
|
||||
# Post the general review comment
|
||||
curl -X POST \
|
||||
-H "Authorization: token $GITHUB_TOKEN" \
|
||||
-H "Accept: application/vnd.github.v3+json" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d @review_comment.json \
|
||||
"https://api.github.com/repos/${{ github.repository }}/pulls/${{ github.event.pull_request.number }}/reviews"
|
||||
|
||||
echo "General review comment posted successfully"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Process line-specific comments
|
||||
echo "Processing line-specific comments..."
|
||||
|
||||
# Initialize arrays for the review
|
||||
declare -a comments=()
|
||||
comment_count=0
|
||||
|
||||
# Read line comments and create GitHub review comments
|
||||
while IFS= read -r line; do
|
||||
# Parse the line: file:line:comment
|
||||
file_path=$(echo "$line" | cut -d: -f1)
|
||||
line_number=$(echo "$line" | cut -d: -f2)
|
||||
comment_text=$(echo "$line" | cut -d: -f3-)
|
||||
|
||||
# Skip if file doesn't exist or line number is invalid
|
||||
if [ ! -f "$file_path" ] || ! [[ "$line_number" =~ ^[0-9]+$ ]]; then
|
||||
echo "Skipping invalid comment: $line"
|
||||
continue
|
||||
fi
|
||||
|
||||
# Create the comment object
|
||||
comment_obj=$(jq -n \
|
||||
--arg path "$file_path" \
|
||||
--arg line "$line_number" \
|
||||
--arg body "🤖 **Ampcode Review:** $comment_text" \
|
||||
'{
|
||||
"path": $path,
|
||||
"line": ($line | tonumber),
|
||||
"body": $body
|
||||
}')
|
||||
|
||||
comments+=("$comment_obj")
|
||||
comment_count=$((comment_count + 1))
|
||||
|
||||
echo "Added comment for $file_path:$line_number"
|
||||
done < line_comments.txt
|
||||
|
||||
# If we have comments, create the review
|
||||
if [ $comment_count -gt 0 ]; then
|
||||
# Create the review payload
|
||||
jq -n \
|
||||
--arg body "## 🤖 Automated Code Review by Ampcode\n\nI've reviewed the changes and found $comment_count issue(s) that need attention. Please review the inline comments below.\n\n---\n*Generated by [Ampcode](https://ampcode.com) • [View Workflow](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})*" \
|
||||
--arg event "REQUEST_CHANGES" \
|
||||
--argjson comments "$(printf '%s\n' "${comments[@]}" | jq -s .)" \
|
||||
'{
|
||||
"body": $body,
|
||||
"event": $event,
|
||||
"comments": $comments
|
||||
}' > review_payload.json
|
||||
|
||||
# Post the review with line-specific comments
|
||||
curl -X POST \
|
||||
-H "Authorization: token $GITHUB_TOKEN" \
|
||||
-H "Accept: application/vnd.github.v3+json" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d @review_payload.json \
|
||||
"https://api.github.com/repos/${{ github.repository }}/pulls/${{ github.event.pull_request.number }}/reviews"
|
||||
|
||||
echo "Posted review with $comment_count line-specific comments"
|
||||
else
|
||||
echo "No valid line-specific comments to post"
|
||||
fi
|
||||
|
||||
- name: Add Review Completed Reaction
|
||||
if: always() && steps.changed-files.outputs.changed_files != ''
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: |
|
||||
# Add a reaction to indicate review has completed
|
||||
curl -X POST \
|
||||
-H "Authorization: token $GITHUB_TOKEN" \
|
||||
-H "Accept: application/vnd.github.v3+json" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d @review_comment.json \
|
||||
"https://api.github.com/repos/${{ github.repository }}/pulls/${{ github.event.pull_request.number }}/reviews"
|
||||
|
||||
echo "Review comment posted successfully"
|
||||
-d '{"content":"white_check_mark"}' \
|
||||
"https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.pull_request.number }}/reactions"
|
||||
|
||||
echo "Added ✅ reaction to indicate review has completed"
|
||||
|
||||
- name: Cleanup
|
||||
if: always()
|
||||
run: |
|
||||
# Clean up temporary files
|
||||
rm -f changed_files.txt ampcode_review.txt review_comment.json
|
||||
rm -f changed_files.txt ampcode_review.txt review_comment.json review_payload.json line_comments.txt
|
||||
echo "Cleanup completed"
|
||||
|
||||
- name: Summary
|
||||
|
||||
14
.github/workflows/close-stale-issues.yml
vendored
14
.github/workflows/close-stale-issues.yml
vendored
@@ -2,7 +2,7 @@ name: Close Stale Issues
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: "0 0 * * *"
|
||||
- cron: '0 0 * * *'
|
||||
|
||||
jobs:
|
||||
stale:
|
||||
@@ -13,9 +13,9 @@ jobs:
|
||||
steps:
|
||||
- uses: actions/stale@v9
|
||||
with:
|
||||
days-before-stale: 3
|
||||
days-before-close: 0
|
||||
only-issues: true
|
||||
stale-issue-label: "stale"
|
||||
stale-issue-message: "This issue is stale (3+ days) and will be closed."
|
||||
close-issue-message: "Closing stale issue."
|
||||
days-before-issue-stale: 3
|
||||
days-before-issue-close: 0
|
||||
days-before-pr-stale: -1
|
||||
stale-issue-label: 'stale'
|
||||
stale-issue-message: 'This issue is stale (3+ days) and will be closed.'
|
||||
close-issue-message: 'Closing stale issue.'
|
||||
|
||||
Reference in New Issue
Block a user