workflows/main: comment on PR instead of failing on spelling errors

Author: airwoodix

.github/workflows/main.yml

@@ -14,6 +14,8 @@ jobs:
     if: github.repository_owner == 'Qiskit'
     name: Build, rustfmt, and python lint
     runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
     steps:
       - name: Print Concurrency Group
         env:
@@ -43,7 +45,24 @@ jobs:
       - name: Check stray release notes
         run: python tools/find_stray_release_notes.py
       - name: Spell check
-        run: typos --exclude releasenotes/ && typos --no-check-filenames releasenotes/
+        id: spell-check
+        run: |
+          status=0
+          echo '### :warning: Spell check failed' > spell-check-output
+          typos --exclude releasenotes/ --format brief >> spell-check-output || status=$?
+          typos --no-check-filenames releasenotes/ --format brief >> spell-check-output || status=$?
+          if [[ ${status} -ne 0 ]]; then
+            echo "failed=true" >> ${GITHUB_OUTPUT}
+            exit 0
+          fi
+          exit ${status}
+      - name: Spell check comment
+        uses: thollander/actions-comment-pull-request@v3
+        if: ${{ github.event_name == 'pull_request' }}
+        with:
+          comment-tag: spell-check-failed
+          file-path: spell-check-output
+          mode: ${{ steps.spell-check.outputs.failed == 'true' && 'upsert' || 'delete' }}
       - name: rustworkx-core Rust Tests
         run: pushd rustworkx-core && cargo test && popd
       - name: rustworkx-core Docs