Merge pull request #357 from commerce-docs/ds_add-suggested-changes

Enable suggested fixes for Markdown

Author: dshevtsov

.github/super-linter.env

@@ -1,8 +1,8 @@
+FIX_MARKDOWN=true
 IGNORE_GITIGNORED_FILES=true
 MARKDOWN_CONFIG_FILE=.markdownlint.yml
 VALIDATE_ALL_CODEBASE=false
 VALIDATE_GIT_MERGE_CONFLICT_MARKERS=true
 VALIDATE_GITHUB_ACTIONS=true
-VALIDATE_JSON=true
 VALIDATE_MARKDOWN=true
 VALIDATE_YAML=true

.github/workflows/test-pull-request.yml

@@ -6,6 +6,7 @@
   permissions:
     contents: read
     statuses: write
+    pull-requests: write
 
   jobs:
     testing:

.github/workflows/validate-pr_job.yml

@@ -3,26 +3,50 @@ name: Reusable workflow to validate a pull request
 
 on: workflow_call
 
-permissions:
-  contents: read
-  statuses: write
-
 jobs:
   lint-test:
     runs-on: ubuntu-latest
 
     steps:
-      - name: Checkout Code
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      - name: Load super-linter configuration
-        run: cat .github/super-linter.env >> "$GITHUB_ENV"
-
-      - name: Lint Code Base
-        uses: super-linter/super-linter/[email protected]
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    - name: Checkout Code
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Setup reviewdog
+      uses: reviewdog/[email protected]
+      with:
+        reviewdog_version: v0.20.3
+
+    - name: Load super-linter configuration
+      shell: bash
+      run: cat .github/super-linter.env >> "$GITHUB_ENV"
+
+    - name: Lint Code Base with super-linter and reviewdog
+      uses: super-linter/super-linter/[email protected]
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Report linting results with reviewdog
+      shell: bash
+      run: |
+        TMPFILE=$(mktemp)
+        git diff > "${TMPFILE}"
+        if [ ! -s "${TMPFILE}" ]; then
+          echo "No changes detected, skipping reviewdog."
+          exit 0
+        fi
+        git stash --include-untracked
+        reviewdog                        \
+          -f=diff                        \
+          -f.diff.strip=1                \
+          -name="markdownlint-fix"       \
+          -reporter="github-pr-review"   \
+          -filter-mode="diff_context"    \
+          -fail-level=error < "${TMPFILE}"
+        git stash drop || true
+      env:
+        REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
   remark-test:
     runs-on: ubuntu-latest

.gitignore

@@ -45,4 +45,11 @@ local-test.yml
 .yalc
 yalc.lock
 
-tmp/
+tmp/
+
+# Super-linter outputs
+super-linter-output
+super-linter.log
+
+# GitHub Actions leftovers
+github_conf