Skip to content

Commit

Permalink
enhance(workflows): suggest fixes with reviewdog (#25154)
Browse files Browse the repository at this point in the history
Adds a new workflow that runs `npm run fix` and suggests changes on the PR.

For security reasons, we run `npm ci` and `npm run fix` in a job without permissions,
and pass the diff as an artifact to a separate job with elevated permissions.
  • Loading branch information
caugner authored Nov 29, 2024
1 parent 7c61530 commit df62f2d
Showing 1 changed file with 63 additions and 0 deletions.
63 changes: 63 additions & 0 deletions .github/workflows/pr-reviewdog.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
name: Reviewdog

on:
pull_request_target:
branches: ["main"]

jobs:
fix:
name: Fix
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- uses: actions/setup-node@v4
with:
node-version-file: ".nvmrc"
cache: npm

- run: npm ci

- run: npm run fix
env:
FORCE_COLOR: 3

- run: git diff > diff.patch

- name: Upload diff
uses: actions/upload-artifact@v4
with:
name: diff
path: diff.patch

suggest:
name: Suggest
needs: fix
runs-on: ubuntu-latest
permissions:
pull-requests: write

steps:
- uses: actions/checkout@v4

- name: Download diff
uses: actions/download-artifact@v4
with:
name: diff

- name: Setup
uses: reviewdog/action-setup@v1
with:
reviewdog_version: latest

- name: Suggest changes
env:
REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
cat diff.patch | reviewdog \
-name="bcd-linter" \
-f=diff \
-f.diff.strip=1 \
-filter-mode=diff_context \
-reporter=github-pr-review

0 comments on commit df62f2d

Please sign in to comment.