chore: add github comment PR action

Fixes #6993

Signed-off-by: Jayapriya Pai <slashpai9@gmail.com>

.github/workflows/checks.yaml

@@ -33,6 +33,21 @@ jobs:
       env:
         GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
 
+  comment-generate-failure:
+    if: ${{ failure() }}
+    permissions:
+      pull-requests: write
+    needs: generate
+    name: Comment troubleshooting message for format and generate failure
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Comment PR
+        uses: thollander/actions-comment-pull-request@v2
+        with:
+         message: 'Auto-generated files are likely not up-to-date. Please make sure to run `make --always-make format generate`, commit the modifications and push the updated branch.'
+
   check-docs:
     runs-on: ubuntu-latest
     name: Check Documentation formatting and links
@@ -48,6 +63,22 @@ jobs:
       env:
         GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
 
+  comment-docs-failure:
+    if: ${{ failure() }}
+    permissions:
+      pull-requests: write
+    needs: check-docs
+    name: Comment troubleshooting message for check-docs failure
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Comment PR
+        uses: thollander/actions-comment-pull-request@v2
+        with:
+          message: |
+            message: 'Formatting and local/remote links likely not correct. Please make sure to run `make check-docs`, commit the modifications and push the updated branch.'
+
   check-golang:
     runs-on: ubuntu-latest
     name: Golang linter