|
| 1 | +name: Lint |
| 2 | + |
| 3 | +permissions: |
| 4 | + contents: read |
| 5 | + |
| 6 | +on: |
| 7 | + pull_request: |
| 8 | + branches: [master, vnext] |
| 9 | + paths: |
| 10 | + - 'docs/**/*.mdx' |
| 11 | + - 'docs/**/*.md' |
| 12 | + - '.markdownlint.json' |
| 13 | + - 'cspell.json' |
| 14 | + |
| 15 | +jobs: |
| 16 | + markdown-lint: |
| 17 | + runs-on: ubuntu-latest |
| 18 | + steps: |
| 19 | + - uses: actions/checkout@v4 |
| 20 | + with: |
| 21 | + fetch-depth: 0 |
| 22 | + |
| 23 | + - uses: actions/setup-node@v4 |
| 24 | + with: |
| 25 | + node-version: 22 |
| 26 | + cache: 'npm' |
| 27 | + |
| 28 | + - run: npm ci |
| 29 | + |
| 30 | + - name: Get changed markdown files |
| 31 | + id: changed |
| 32 | + run: | |
| 33 | + FILES=$(git diff --name-only --diff-filter=ACMR origin/${{ github.base_ref }}...HEAD -- 'docs/**/*.mdx' 'docs/**/*.md' | tr '\n' ' ') |
| 34 | + echo "files=$FILES" >> "$GITHUB_OUTPUT" |
| 35 | + echo "Found changed files: $FILES" |
| 36 | +
|
| 37 | + - name: Markdownlint (changed files) |
| 38 | + if: steps.changed.outputs.files != '' |
| 39 | + run: npx markdownlint ${{ steps.changed.outputs.files }} |
| 40 | + |
| 41 | + - name: Summary |
| 42 | + if: always() && steps.changed.outputs.files != '' |
| 43 | + run: | |
| 44 | + echo "## Markdownlint Results" >> "$GITHUB_STEP_SUMMARY" |
| 45 | + RESULT=$(npx markdownlint ${{ steps.changed.outputs.files }} 2>&1 || true) |
| 46 | + ERRORS=$(echo "$RESULT" | grep -c "MD[0-9]" || echo "0") |
| 47 | + FILES_WITH_ERRORS=$(echo "$RESULT" | grep "MD[0-9]" | cut -d: -f1 | sort -u | wc -l || echo "0") |
| 48 | + echo "**$ERRORS errors** in **$FILES_WITH_ERRORS files**" >> "$GITHUB_STEP_SUMMARY" |
| 49 | + if [ "$ERRORS" -gt 0 ]; then |
| 50 | + echo '```' >> "$GITHUB_STEP_SUMMARY" |
| 51 | + echo "$RESULT" >> "$GITHUB_STEP_SUMMARY" |
| 52 | + echo '```' >> "$GITHUB_STEP_SUMMARY" |
| 53 | + fi |
| 54 | +
|
| 55 | + spellcheck: |
| 56 | + runs-on: ubuntu-latest |
| 57 | + steps: |
| 58 | + - uses: actions/checkout@v4 |
| 59 | + with: |
| 60 | + fetch-depth: 0 |
| 61 | + |
| 62 | + - uses: actions/setup-node@v4 |
| 63 | + with: |
| 64 | + node-version: 22 |
| 65 | + cache: 'npm' |
| 66 | + |
| 67 | + - run: npm ci |
| 68 | + |
| 69 | + - name: Get changed markdown files |
| 70 | + id: changed |
| 71 | + run: | |
| 72 | + FILES=$(git diff --name-only --diff-filter=ACMR origin/${{ github.base_ref }}...HEAD -- 'docs/**/*.mdx' 'docs/**/*.md' | tr '\n' ' ') |
| 73 | + echo "files=$FILES" >> "$GITHUB_OUTPUT" |
| 74 | +
|
| 75 | + - name: CSpell (changed files) |
| 76 | + if: steps.changed.outputs.files != '' |
| 77 | + run: npx cspell --no-progress ${{ steps.changed.outputs.files }} |
| 78 | + |
| 79 | + - name: Summary |
| 80 | + if: always() && steps.changed.outputs.files != '' |
| 81 | + run: | |
| 82 | + echo "## CSpell Results" >> "$GITHUB_STEP_SUMMARY" |
| 83 | + RESULT=$(npx cspell --no-progress ${{ steps.changed.outputs.files }} 2>&1 || true) |
| 84 | + ERRORS=$(echo "$RESULT" | grep -c "Unknown word" || echo "0") |
| 85 | + FILES_WITH_ERRORS=$(echo "$RESULT" | grep "Unknown word" | cut -d: -f1 | sort -u | wc -l || echo "0") |
| 86 | + echo "**$ERRORS errors** in **$FILES_WITH_ERRORS files**" >> "$GITHUB_STEP_SUMMARY" |
| 87 | + if [ "$ERRORS" -gt 0 ]; then |
| 88 | + echo '```' >> "$GITHUB_STEP_SUMMARY" |
| 89 | + echo "$RESULT" >> "$GITHUB_STEP_SUMMARY" |
| 90 | + echo '```' >> "$GITHUB_STEP_SUMMARY" |
| 91 | + fi |
0 commit comments