PR desc check action (#32)

fix #31

Add PR Description Check action

Test:

- failed:
https://github.com/YanxuanLiu/spark-rapids/actions/runs/15180102691/job/42687649884?pr=27
- success:
https://github.com/YanxuanLiu/spark-rapids/actions/runs/15180114186/job/42687683579?pr=27

---------

Signed-off-by: Yanxuan Liu <[email protected]>

Author: YanxuanLiu

.github/workflows/pr-desc-check.yml

@@ -0,0 +1,34 @@
+# Copyright (c) 2025, NVIDIA CORPORATION.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# A workflow to check if comment exists in PR description
+name: pr description check
+
+on:
+  pull_request:
+    types: [opened, edited, reopened]
+
+jobs:
+  pr-description-check:
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: read
+      statuses: write
+      contents: read  
+    if: "!contains(github.event.pull_request.title, '[bot]')"
+    steps:
+      - name: pr-description-check
+        uses: NVIDIA/spark-rapids-common/pr-description-check@main
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

pr-description-check/action.yml

@@ -0,0 +1,53 @@
+# Copyright (c) 2025, NVIDIA CORPORATION.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: 'PR Description Check'
+description: 'check if comment exists in PR description'
+inputs:
+  github-token:
+    description: "github token"
+    required: true
+    type: string
+
+runs:
+  using: "composite"
+  steps:
+    - name: Get PR description
+      id: pr_description
+      uses: actions/github-script@v7
+      with:
+        github-token: ${{ inputs.github-token }}
+        script: |
+          const pr = context.payload.pull_request;
+          const prBody = pr.body || '';
+          const sha = pr.head.sha;
+          const hasComment = prBody.includes('<!--');
+          const state = hasComment ? 'failure' : 'success';
+          const description = hasComment
+            ? 'PR description contains comment in "<!--". Please remove the comment manually.'
+            : 'PR description is valid.';
+
+          if (hasComment) {
+            core.setFailed(description);
+          }
+
+          await github.rest.repos.createCommitStatus({
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            sha: sha,
+            state: state,
+            target_url: pr.html_url,
+            description: description.substring(0, 140),
+            context: 'PR Description'
+          });