Changeset 59169

Timestamp:

10/04/2024 03:35:13 PM (5 months ago)

Author:

desrosj

Message:

Build/Test Tools: Clean up PR comments after action is taken.

There’s now a number of automated comments left on pull requests to help contributors that a PR can easily be overridden with activity.

Some of the comments are only relevant until a specific action is taken. One such comment is for informing the PR author that a link to a Trac ticket is a requirement for considering any suggested changes.

This updates the pull request comment workflow to remove the comment once a link to a Trac ticket is properly included.

Props debarghyabanerjee.
Fixes #61567.

File:

• trunk/.github/workflows/pull-request-comments.yml (modified) (4 diffs)

trunk/.github/workflows/pull-request-comments.yml

@@ -4 +4 @@
 on:
   pull_request_target:
-    types: [ 'opened' ]
+    types: [ 'opened', 'synchronize', 'reopened', 'edited' ]
   workflow_run:
     workflows: [ 'Test Build Processes' ]
@@ -165 +165 @@
             github.rest.issues.createComment( commentInfo );
 
-  # Leaves a comment on a pull request when no Trac ticket is included in the pull request description.
+  # Manages comments reminding contributors to include a Trac ticket link when opening a pull request.
   trac-ticket-check:
-    name: Comment on a pull request when no Trac ticket is included
+    name: Manage Trac ticket reminders for pull requests
     runs-on: ubuntu-latest
     permissions:
@@ -174 +174 @@
     if: ${{ github.repository == 'WordPress/wordpress-develop' && github.event_name == 'pull_request_target' && ! github.event.pull_request.draft && github.event.pull_request.state == 'open' }}
     steps:
-      - name: Check for Trac ticket and comment if missing
+      - name: Check for Trac ticket and manage comment
         uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
         with:
@@ -184 +184 @@
             const comments = ( await github.rest.issues.listComments( { owner, repo, issue_number: number } ) ).data;
 
-            const hasMissingTicketComment = comments.some( comment =>
-              comment.user.type === 'Bot' && comment.body.includes( 'Trac Ticket Missing' )
-            );
-
-            if ( hasMissingTicketComment ) return;
+            const hasMissingTicketComment = comments.find( comment => comment.user.type === 'Bot' && comment.body.includes( 'Trac Ticket Missing' ) );
+
+            if ( hasMissingTicketComment ) {
+              // Trac ticket link found, delete existing "Trac Ticket Missing" comment.
+              await github.rest.issues.deleteComment( { owner, repo, comment_id: hasMissingTicketComment.id } );
+              return;
+            }
 
             // No comment was found. Create one.