feat: add deprecation notice to check on PRs (#277)

puzzler7 · web-flow · commit 188fcf65e621 · 2025-05-08T15:55:15.000-07:00
Posts a comment on the PR if check on PRs is run. Tested that it works and only posts one comment, even if run multiple times. <img width="928" alt="Screenshot 2025-05-08 at 3 44 17 PM" src="https://github.com/user-attachments/assets/57035f07-ab06-4ae4-bebd-8f8dd0a908ad" />
diff --git a/action.yaml b/action.yaml
@@ -265,6 +265,28 @@ runs:
           echo .trunk/setup-ci >>.git/info/exclude
         fi
 
+    - name: Find Comment
+      uses: peter-evans/find-comment@v3
+      if: env.INPUT_SETUP_DEPS == 'true'
+      id: fc
+      with:
+        issue-number: ${{ env.GITHUB_EVENT_PULL_REQUEST_NUMBER }}
+        repository: ${{ env.INPUT_TARGET_CHECKOUT }}
+        token: ${{ env.INPUT_GITHUB_TOKEN }}
+        body-regex: ^.*https://docs.trunk.io/code-quality/setup-and-installation/prevent-new-issues/migration-guide.*$
+
+    - name: Post comment
+      uses: peter-evans/create-or-update-comment@v4
+      if: env.INPUT_SETUP_DEPS == 'true'
+      with:
+        comment-id: ${{ steps.fc.outputs.comment-id }}
+        issue-number: ${{ env.GITHUB_EVENT_PULL_REQUEST_NUMBER }}
+        repository: ${{ env.INPUT_TARGET_CHECKOUT }}
+        token: ${{ env.INPUT_GITHUB_TOKEN }}
+        edit-mode: replace
+        body: |
+          Code-Quality-on-PRs is deprecated and will soon be removed. Please see the [migration guide](https://docs.trunk.io/code-quality/setup-and-installation/prevent-new-issues/migration-guide) for more information.
+
     - name: Set up env
       uses: ./.trunk/setup-ci
       if: env.INPUT_SETUP_DEPS == 'true'
