doc-lint.yml

name: Doc Lint

on:
  push:
    paths:
      - 'docs/**'
      - '**/*.md'
  pull_request:
    branches: [master, 'release/**']
    paths:
      - 'docs/**'
      - '**/*.md'

permissions:
  contents: read

jobs:
  markdownlint:
    name: 🍇 Markdown
    runs-on: ubuntu-latest
    timeout-minutes: 1
    steps:
      - uses: actions/checkout@v3
      - name: 🚀 Use Node.js
        uses: actions/setup-node@v3.4.1
        with:
          node-version: '12.x'
      - run: npm install -g markdownlint-cli@0.25.0
      - run: markdownlint '**/*.md'
      - name: check category
        run: |
          ./utils/check-category.py
      - name: check Chinese doc
        run: |
          sudo pip3 install zhon
          ./utils/fix-zh-doc-segment.py > \
            /tmp/check.log 2>&1 || (cat /tmp/check.log && exit 1)
          if grep "find broken newline in file: " /tmp/check.log; then
            cat /tmp/check.log
            echo "Newline can't appear in the middle of Chinese sentences."
            echo "You need to run ./utils/fix-zh-doc-segment.py to fix them."
            exit 1
          fi

  Chinse-Copywriting-lint:
    name: Chinese Copywriting
    runs-on: ubuntu-latest
    timeout-minutes: 1
    steps:
      - uses: actions/checkout@v3
      - name: check Chinese copywriting
        run: |
          version=v1.5.6
          wget -O- "https://github.com/huacnlee/autocorrect/releases/download/$version/autocorrect-linux-amd64.tar.gz" | tar -xzv
          mv -v autocorrect /usr/local/bin/
          autocorrect --version
          git ls-files -- "docs/zh/latest/**.md" | xargs -t autocorrect --lint