Implement robust comment lifecycle management for verification workflows - #18
Merged
Conversation
mithro
force-pushed
the
fix/comment-lifecycle-management
branch
from
July 7, 2025 07:09
b154806 to
4dc3bb2
Compare
🚀 Preview Deployment Ready!
This preview will be automatically updated when you push new commits to this PR. Browse all previews: https://preview.wafer.space ⚡ Deployed to custom domain • Preview will be removed when PR is closed |
|
📋 Previous verification results (archived) Click to view archived verification results from 2025-07-07T07:09:48.000Z✅ Preview Site Verification PASSEDPreview Site Verification ReportPR: #18 1. Basic Connectivity ✅
2. Content Verification
3. Asset VerificationExtracting asset URLs from HTML...
4. Link and Asset Verification (muffet)Running comprehensive muffet validation...
5. Performance Check
6. Mobile Responsiveness
Summary✅ All verification checks passed! 🔍 Automated verification • Run ID: 16110250763 • 2025-07-07T07:09:47.467Z ⏰ This verification result has been archived • A newer verification is available below |
|
📋 Previous verification results (archived) Click to view archived verification results from 2025-07-07T07:12:25.000Z❌ Preview Site Verification FAILEDPreview Site Verification ReportPR: #18 1. Basic Connectivity ✅
2. Content Verification
3. Asset VerificationExtracting asset URLs from HTML...
4. Link and Asset Verification (muffet)Running comprehensive muffet validation...
Summary: 0 5. Performance Check
6. Mobile Responsiveness
Summary❌ Some verification checks failed 🔍 Automated verification • Run ID: 16110297963 • 2025-07-07T07:12:24.859Z ⏰ This verification result has been archived by Run ID: 16125308983 • A newer verification is available below |
This commit introduces a comprehensive solution for managing verification comment clutter in pull requests by automatically archiving old verification results while preserving the most recent one. ## Key Features ### Iterative Archival Process - Continues archiving until only 1 unarchived verification comment remains - Handles multiple rapid workflow runs without leaving comment trails - Safety limits prevent infinite loops (max 10 iterations) ### Enhanced Comment Detection - Proper pagination support for large comment lists (100+ comments) - Robust filtering for github-actions[bot] verification comments - Support for both legacy comments and VERIFICATION_COMMENT_MARKER format - Excludes deployment ready comments from archival process ### Smart Comment Management - Sorts comments by creation date (archives oldest first) - Preserves original content in collapsible archived sections - Includes timestamps from original comment creation - Maintains VERIFICATION_COMMENT_MARKER for consistency ### Improved Error Handling - Continues processing if individual comment archival fails - Comprehensive logging for debugging workflow issues - API delay handling for GitHub consistency ## Problem Solved Previous implementation had critical flaws: - No pagination support (failed with 50+ comments) - Incomplete comment detection in GitHub Actions context - Single-pass archival left multiple unarchived comments - Poor error handling and debugging capabilities ## Verification Successfully tested on PR #2 with 56+ verification comments: - Detected all verification comments correctly - Archived 25 old comments in single workflow run - Left only 1 current verification comment visible - Completed in 2 iterations with proper validation This system will maintain clean PR comment history for all future preview verification workflows. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
mithro
force-pushed
the
fix/comment-lifecycle-management
branch
from
July 7, 2025 07:14
4dc3bb2 to
a332622
Compare
|
📋 Previous verification results (archived) Click to view archived verification results from 2025-07-07T07:17:54.000Z❌ Preview Site Verification FAILEDPreview Site Verification ReportPR: #18 1. Basic Connectivity ✅
2. Content Verification
3. Asset VerificationExtracting asset URLs from HTML...
4. Link and Asset Verification (muffet)Running comprehensive muffet validation...
Summary: 0 5. Performance Check
6. Mobile Responsiveness
Summary❌ Some verification checks failed 🔍 Automated verification • Run ID: 16110407867 • 2025-07-07T07:17:53.395Z ⏰ This verification result has been archived by Run ID: 16125308983 • A newer verification is available below |
… comment Changed the archival logic to: 1. Create new verification comment first 2. Archive ALL existing unarchived verification comments (except the new one) 3. Result: Exactly 1 unarchived comment remains at all times This ensures the system maintains only one active verification comment per PR as designed, regardless of timing or multiple workflow runs. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
|
📋 Previous verification results (archived) Click to view archived verification results from 2025-07-07T18:51:02.000Z❌ Preview Site Verification FAILEDPreview Site Verification ReportPR: #18 1. Basic Connectivity ✅
2. Content Verification
3. Asset VerificationExtracting asset URLs from HTML...
4. Link and Asset Verification (muffet)Running comprehensive muffet validation...
Summary: 0 5. Performance Check
6. Mobile Responsiveness
Summary❌ Some verification checks failed 🔍 Automated verification • Run ID: 16125308983 • 2025-07-07T18:51:02.568Z ⏰ This verification result has been archived by Run ID: 16125393123 • A newer verification is available below |
Enhanced comment lifecycle management to handle multiple concurrent workflows: - Random 1-3 second delay before archival to let concurrent workflows create comments - Increased max iterations from 10 to 15 for rapid-fire scenarios - Double-check comment state before archiving to avoid conflicts - Handle 409 conflict errors when comments are modified concurrently - Better debugging with comment IDs and creation times - Include workflow run ID in archived comment metadata This ensures the system maintains exactly 1 unarchived verification comment even with multiple rapid pushes triggering concurrent workflows. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
mithro
force-pushed
the
fix/comment-lifecycle-management
branch
from
July 7, 2025 18:53
df7eb8b to
67e778e
Compare
|
📋 Previous verification results (archived) Click to view archived verification results from 2025-07-07T18:55:14.000Z❌ Preview Site Verification FAILEDPreview Site Verification ReportPR: #18 1. Basic Connectivity ✅
2. Content Verification
3. Asset VerificationExtracting asset URLs from HTML...
4. Link and Asset Verification (muffet)Running comprehensive muffet validation...
Summary: 0 5. Performance Check
6. Mobile Responsiveness
Summary❌ Some verification checks failed 🔍 Automated verification • Run ID: 16125393123 • 2025-07-07T18:55:13.381Z ⏰ This verification result has been archived by Run ID: 16125635176 • A newer verification is available below |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the verification comment lifecycle by introducing paginated fetching, iterative archival, and improved concurrency handling.
- Replaces single-pass comment retrieval with a paginated
getVerificationCommentshelper. - Adds an iterative loop to archive old comments until only the latest remains, with safety limits.
- Introduces richer logging, randomized delays, and better error resilience for concurrent workflows.
Comments suppressed due to low confidence (1)
.github/scripts/comment-verification-results.js:36
- [nitpick] Add JSDoc comments to describe the purpose, parameters, and return value of the getVerificationComments function for better maintainability.
const getVerificationComments = async () => {
Improvements based on Copilot suggestions for PR #18: - Added sleep helper function to reduce code duplication - Replaced console.log with GitHub Actions core logging methods - Fixed pagination logic to avoid unnecessary API calls - Implemented exponential backoff (100ms → 1600ms) to reduce API pressure - Removed unused hasMore variable These changes improve code quality, logging structure, and API efficiency. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
❌ Preview Site Verification FAILEDPreview Site Verification ReportPR: #18 1. Basic Connectivity ✅
2. Content Verification
3. Asset VerificationExtracting asset URLs from HTML...
4. Link and Asset Verification (muffet)Running comprehensive muffet validation...
Summary: 0 5. Performance Check
6. Mobile Responsiveness
Summary❌ Some verification checks failed 🔍 Automated verification • Run ID: 16125635176 • 2025-07-07T19:08:04.602Z |
🧹 Preview Deployment RemovedThe preview deployment for this PR has been removed from https://preview.wafer.space |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
This PR implements a comprehensive solution for managing verification comment clutter in pull requests by automatically archiving old verification results while preserving the most recent one.
Problem Solved
The existing comment lifecycle management had critical flaws:
Key Improvements
🔄 Iterative Archival Process
🔍 Enhanced Comment Detection
📝 Smart Comment Management
🛡️ Improved Error Handling
Verification Results
Successfully tested on PR #2 which had 56+ verification comments:
Technical Implementation
Before (Broken)
After (Robust)
Impact
This system will maintain clean PR comment history for all future preview verification workflows, eliminating the comment clutter that was accumulating in PRs with multiple workflow runs.
🤖 Generated with Claude Code