proofreading.yml

name: Proofreading

on:
  pull_request:
    branches:
      - main
    paths:
      - '.github/workflows/proofreading.yml'
      - '**.md'
      - 'package.json'
      - 'package-lock.json'

# Only cancel in-progress jobs or runs for the current workflow
concurrency: 
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

permissions: {}

jobs:
  textlint:
    name: Check from Textlint
    runs-on: ubuntu-latest
    permissions:
      pull-requests: write 

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Setup Node.js environment
        uses: actions/setup-node@v4.0.0
        with:
          node-version: 18

      - name: Setup from package.json
        run: npm ci 

      - name: Setup reviewdog
        uses: reviewdog/action-setup@v1.1.0
        with:
          reviewdog_version: latest

      - name: Run lint
        run: npx textlint -f checkstyle './{articles,books}/*.md' >> .textlint.log

      - name: Run reviewdog
        if: failure()
        env:
          REVIEWDOG_GITHUB_API_TOKEN: ${{ github.token }}
        run: cat .textlint.log  | reviewdog -f=checkstyle -name="textlint" -reporter="github-pr-review"