feat(ci): Add Reviewdog for Prettier formatting (#14703)

* feat(ci): Add Reviewdog for Prettier formatting * Update .github/workflows/reviewdog.yml Co-authored-by: A1lo <[email protected]> --------- Co-authored-by: A1lo <[email protected]>
mdn · Jul 29, 2023 · 9574d0e · 9574d0e
1 parent 3a9e884
commit 9574d0e
Showing 1 changed file with 45 additions and 0 deletions.
diff --git a/.github/workflows/reviewdog.yml b/.github/workflows/reviewdog.yml
@@ -0,0 +1,45 @@
+name: reviewdog
+
+on:
+  - pull_request
+
+jobs:
+  prettier:
+    # do not run on forks
+    if: github.repository == 'mdn/translated-content'
+    name: prettier
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Get changed files
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BASE_SHA: ${{ github.event.pull_request.base.sha }}
+          HEAD_SHA: ${{ github.event.pull_request.head.sha }}
+        run: |
+          # Use the GitHub API to get the list of changed files
+          # documenation: https://docs.github.com/rest/commits/commits#compare-two-commits
+          DIFF_DOCUMENTS=$(gh api repos/{owner}/{repo}/compare/${{ env.BASE_SHA }}...${{ env.HEAD_SHA }} --jq '.files | .[] | select(.status|IN("added", "modified", "renamed", "copied", "changed")) | .filename' | xargs)
+          echo "DIFF_DOCUMENTS=${DIFF_DOCUMENTS}" >> $GITHUB_ENV
+
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: ".nvmrc"
+          cache: yarn
+
+      - name: Install all yarn packages
+        run: yarn --frozen-lockfile
+        env:
+          # https://github.com/microsoft/vscode-ripgrep#github-api-limit-note
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Perform linting
+        run: yarn prettier --ignore-unknown --write ${{ env.DIFF_DOCUMENTS }}
+
+      - name: Submit suggestion
+        uses: reviewdog/action-suggester@v1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          tool_name: prettier