Merge pull request #4472 from DataDog/tonycthsu/doc-linter

Update doc for linter debug locally

Author: TonyCTHsu

.github/workflows/check.yml

@@ -93,8 +93,7 @@ jobs:
     needs: ['build']
     container: ghcr.io/datadog/images-rb/engines/ruby:3.3
     steps:
-      - name: Checkout
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
           persist-credentials: false
       - name: Restore bundle cache
@@ -144,11 +143,8 @@ jobs:
   zizmor:
     name: zizmor
     runs-on: ubuntu-24.04
-    permissions:
-      security-events: write
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
           persist-credentials: false
       - name: Run zizmor 🌈
@@ -165,7 +161,8 @@ jobs:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
           persist-credentials: false
-      - uses: docker://rhysd/actionlint:1.7.7
+      - name: Run actionlint
+        uses: docker://rhysd/actionlint:1.7.7
         with:
           args: -color
 
@@ -177,7 +174,8 @@ jobs:
         with:
           persist-credentials: false
       - run: pip install yamllint
-      - run: yamllint --strict .
+      - name: Run yamllint
+        run: yamllint --strict .
 
   complete:
     name: Static Analysis (complete)

docs/DevelopmentGuide.md

@@ -306,6 +306,23 @@ To change your code to the version that standard wants, run:
 $ bundle exec rake standard:fix
 ```
 
+For non-Ruby code, follow the instructions below to debug locally, if CI failed with respective linter.
+
+- For `yamllint`, run:
+```bash
+docker run --rm -v $(pwd):/app -w /app cytopia/yamllint .
+```
+
+- For `actionlint`, run:
+```bash
+docker run --rm -v $(pwd):/app -w /app rhysd/actionlint -color
+```
+
+- For `zizmor`, run:
+```bash
+docker run --rm -v $(pwd):/app -w /app -e GH_TOKEN=$(gh auth token) ghcr.io/woodruffw/zizmor --min-severity low .
+```
+
 ## Appendix
 
 ### Writing new integrations