Add name input to prevent reviewdog from overwriting comments from …

…other runs (#39)

* Add `-name` input for the action

* Add an explanation for `-name` input in  README

* Correct English

* Revise README

README.md

@@ -39,6 +39,12 @@ inputs:
       Exit code for reviewdog when errors are found [true,false]
       Default is `false`.
     default: 'false'
+  name:
+    description: |
+      Tool name shown in review comment for reviewdog.
+      Also acts as an identifier for determining which comments reviewdog should overwrite.
+      Useful in monorepos with multiple root modules where terraform validate needs to run multiple times.
+    default: 'terraform validate'
   reviewdog_flags:
     description: 'Additional reviewdog flags'
     default: ''
@@ -49,6 +55,8 @@ inputs:
 
 ## Usage
 
+### For single root module
+
 ```yaml
 name: reviewdog
 on: [pull_request]
@@ -67,3 +75,30 @@ jobs:
           # GitHub Status Check won't become failure with warning.
           level: warning
 ```
+
+### For multiple root modules
+
+```yaml
+name: reviewdog
+on: [pull_request]
+jobs:
+  terraform_validate:
+    name: runner / terraform validate
+    strategy:
+      matrix:
+        root_module:
+          - development
+          - production
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: reviewdog/action-terraform-validate@v1
+        with:
+          github_token: ${{ secrets.github_token }}
+          reporter: github-pr-review
+          level: warning
+          # Explicitly specify a root module path for each job.
+          workdir: ./terraform/${{ matrix.root_module }}
+          # Explicitly specify a unique name for each job to prevent reviewdog from overwriting comments across jobs.
+          name: terraform validate ${{ matrix.root_module }}
+```

action.yml

@@ -28,6 +28,12 @@ inputs:
       Exit code for reviewdog when errors are found [true,false]
       Default is `false`.
     default: 'false'
+  name:
+    description: |
+      Tool name shown in review comment for reviewdog.
+      Also acts as an identifier for determining which comments reviewdog should overwrite.
+      Useful in monorepos with multiple root modules where terraform validate needs to run multiple times.
+    default: 'terraform validate'
   reviewdog_flags:
     description: 'Additional reviewdog flags'
     default: ''

entrypoint.sh

@@ -42,7 +42,7 @@ terraform init -backend=false
 terraform validate -json \
   | jq "$jq_script" -c \
   | reviewdog -f="rdjsonl" \
-      -name="terraform validate" \
+      -name="${INPUT_NAME}" \
       -reporter="${INPUT_REPORTER:-github-pr-check}" \
       -filter-mode="${INPUT_FILTER_MODE}" \
       -fail-on-error="${INPUT_FAIL_ON_ERROR}" \