ci(comment): convert workflow to action

No need to keep this level of isolation between these tasks.

Signed-off-by: Randolph Sapp <rs@ti.com>

Author: StaticRocket

.github/actions/comment/action.yml

@@ -0,0 +1,31 @@
+---
+name: "comment"
+description: "Comment on a given pull request or issue"
+inputs:
+  token:
+    description: "A token with pull request or issue write permission"
+    required: true
+
+runs:
+  using: "composite"
+  steps:
+    - name: Update pr with info from other runners
+      uses: actions/github-script@v7
+      with:
+        github-token: ${{ inputs.token }}
+        script: |
+          var fs = require('fs');
+          var issue_number = Number(fs.readFileSync('./results/id'));
+          var problem_count = Number(fs.readFileSync(
+            './results/problem-count'
+          ));
+          var summary = String(fs.readFileSync('./results/summary'));
+
+          if (problem_count > 0) {
+            github.rest.issues.createComment({
+              owner: context.repo.owner,
+              issue_number: issue_number,
+              repo: context.repo.repo,
+              body: summary
+            });
+          }

.github/workflows/check-files.yml

@@ -26,6 +26,9 @@ jobs:
       image: ghcr.io/texasinstruments/processor-sdk-doc:latest
       options: --entrypoint /bin/bash
 
+    permissions:
+      pull-requests: write  # Required to comment on pull requests
+
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -40,6 +43,7 @@ jobs:
           git switch master
 
       - name: Run check_files.py
+        id: check
         env:
           EVENT_NUMBER: ${{ github.event.number }}
         run: |
@@ -69,10 +73,8 @@ jobs:
           # Exit with error if there are new warnings
           [ "$WARNING_COUNT" -eq "0" ]
 
-      - name: Save results
-        uses: actions/upload-artifact@v4
+      - name: Comment
+        uses: ./.github/actions/comment
         if: always()
         with:
-          name: results
-          path: results/
-          retention-days: 1
+          token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/check_toc_txt.yml

@@ -27,6 +27,9 @@ jobs:
       image: ghcr.io/texasinstruments/processor-sdk-doc:latest
       options: --entrypoint /bin/bash
 
+    permissions:
+      pull-requests: write  # Required to comment on pull requests
+
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -70,10 +73,8 @@ jobs:
           # Exit with error if there are new warnings
           [ "$WARNING_COUNT" -eq "0" ]
 
-      - name: Save results
-        uses: actions/upload-artifact@v4
+      - name: Comment
+        uses: ./.github/actions/comment
         if: always()
         with:
-          name: results
-          path: results/
-          retention-days: 1
+          token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/comment.yml

@@ -26,6 +26,9 @@ jobs:
       image: ghcr.io/texasinstruments/processor-sdk-doc:latest
       options: --entrypoint /bin/bash
 
+    permissions:
+      pull-requests: write  # Required to comment on pull requests
+
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -69,10 +72,8 @@ jobs:
           # Exit with error if there are new warnings
           [ "$WARNING_COUNT" -eq "0" ]
 
-      - name: Save results
-        uses: actions/upload-artifact@v4
+      - name: Comment
+        uses: ./.github/actions/comment
         if: always()
         with:
-          name: results
-          path: results/
-          retention-days: 1
+          token: ${{ secrets.GITHUB_TOKEN }}