Changeset 57523 for trunk/.github/workflows/props-bot.yml

Timestamp:

02/02/2024 04:35:59 PM (7 months ago)

Author:

desrosj

Message:

Build/Test Tools: Some improvements to the Props Bot workflow.

This makes a few improvements made to the Props Bot workflow:

• The bot will no longer run on draft PRs.
• The bot will no longer run on closed PRs.
• The bot will no longer run when a comment is deleted (this should almost never happen).

Props mamaduka, gziolo.
See #60417.

File:

• trunk/.github/workflows/props-bot.yml (modified) (5 diffs)

trunk/.github/workflows/props-bot.yml

@@ -2 +2 @@
 
 on:
-  # This event runs anytime a PR is (re)opened, updated, or labeled.
+  # This event runs anytime a PR is (re)opened, updated, marked ready for review, or labeled.
   # GitHub does not allow filtering the `labeled` event by a specific label.
   # However, the logic below will short-circuit the workflow when the `props-bot` label is not the one being added.
-  # Note: The pull_request_target event is uesed instead of pull_request because this workflow needs permission to comment
+  # Note: The pull_request_target event is used instead of pull_request because this workflow needs permission to comment
   # on the pull request. Because this event grants extra permissions to `GITHUB_TOKEN`, any code changes within the PR
   # should be considered untrusted. See https://securitylab.github.com/research/github-actions-preventing-pwn-requests/.
@@ -14 +14 @@
       - reopened
       - labeled
+      - ready_for_review
   # This event runs anytime a comment is added or deleted.
   # You cannot filter this event for PR comments only.
@@ -20 +21 @@
     type:
       - created
-      - deleted
   # This event will run everytime a new PR review is initially submitted.
   pull_request_review:
@@ -29 +29 @@
     types:
       - created
-      - deleted
 
 # Cancels all previous workflow runs for pull requests that have not completed.
@@ -56 +55 @@
       contents: read
     timeout-minutes: 20
-    # The job should only run if:
+    # The job will run when pull requests are open, ready for review and:
     #
-    # - A pull request review is created or commented on.
-    # - An issue comment is added to a pull request.
-    # - A pull request is opened, synchronized, or reopened.
+    # - A comment is added to the pull request.
+    # - A review is created or commented on.
+    # - The pull request is opened, synchronized, marked ready for review, or reopened.
     # - The `props-bot` label is added to the pull request.
     if: |
-      contains( fromJSON( '["pull_request_review", "pull_request_review_comment"]' ), github.event_name ) ||
-      ( github.event_name == 'issue_comment' && github.event.issue.pull_request ) ||
-      github.event_name == 'pull_request_target' && github.event.action != 'labeled' ||
-      'props-bot' == github.event.label.name
+      (
+        github.event_name == 'issue_comment' && github.event.issue.pull_request ||
+        contains( fromJSON( '["pull_request_review", "pull_request_review_comment"]' ), github.event_name ) ||
+        github.event_name == 'pull_request_target' && github.event.action != 'labeled' ||
+        'props-bot' == github.event.label.name
+      ) &&
+      ( ! github.event.pull_request.draft && github.event.pull_request.state == 'open' || ! github.event.issue.draft && github.event.issue.state == 'open' )
 
     steps: