reviewdog-markdown.yml

#
# Copyright (C) 2019-2024 vdaas.org vald team <vald@vdaas.org>
#
# Licensed under the Apache License, Version 2.0 (the "License");
# You may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

name: "Reviewdog - Markdown"
on:
  pull_request:
    paths-ignore:
      - "apis/docs/v1/docs.md"
      - "CHANGELOG.md"
jobs:
  dump-contexts-to-log:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: ./.github/actions/dump-context
  languagetool-apis-charts:
    name: runner / LanguageTool / apis & charts
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Set Git config
        run: |
          git config --global --add safe.directory ${GITHUB_WORKSPACE}
      - name: LanguageTool
        uses: reviewdog/action-languagetool@v1
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          reporter: github-pr-review
          patterns: "apis/**/*.md apis/**/*.md.gotmpl charts/**/*.md !charts/vald/README.md"
          level: warning
          language: en-US
          disabled_rules: "DOUBLE_PUNCTUATION,WORD_CONTAINS_UNDERSCORE,ARROWS,CURRENCY,DASH_RULE,EN_QUOTES"
          disabled_categories: "TYPOS,TYPOGRAPHY,STYLE,CASING"
  languagetool-docs:
    name: runner / LanguageTool / Docs
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Set Git config
        run: |
          git config --global --add safe.directory ${GITHUB_WORKSPACE}
      - name: LanguageTool
        uses: reviewdog/action-languagetool@v1
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          reporter: github-pr-review
          patterns: "**/*.md **/*.md.gotmpl !**/CHANGELOG.md !apis/** !charts/**"
          level: warning
          language: en-US
          disabled_rules: "DOUBLE_PUNCTUATION,WORD_CONTAINS_UNDERSCORE,ARROWS,CURRENCY,DASH_RULE,EN_QUOTES"
          disabled_categories: "TYPOS,TYPOGRAPHY,STYLE"
  textlint:
    name: runner / textlint
    runs-on: ubuntu-latest
    env:
      REVIEWDOG_GITHUB_API_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
    steps:
      - uses: actions/checkout@v4
      - name: Set Git config
        run: |
          git config --global --add safe.directory ${GITHUB_WORKSPACE}
      - name: Setup node/npm
        uses: actions/setup-node@v4
        with:
          node-version: "latest"
      - name: Install textlint
        run: |
          make reviewdog/install
          make textlint/ci/install
      - name: Run lint for files && Report to GitHub
        run: |
          make CSPELL_EXTRA_OPTIONS="--no-summary --no-progress" files/cspell | \
          reviewdog \
            -efm='%f:%l:%c - %m' \
            -name="file name cspell" \
            -diff="git diff ${{ github.event.pull_request.base.ref }}" \
            -reporter=github-pr-review \
            -level=error
          make TEXTLINT_EXTRA_OPTIONS="-f checkstyle" files/textlint | \
          reviewdog \
            -f=checkstyle \
            -name="file name textlint" \
            -diff="git diff ${{ github.event.pull_request.base.ref }}" \
            -reporter=github-pr-review \
            -level=error
      - name: Run lint for documents && Report to GitHub
        run: |
          make CSPELL_EXTRA_OPTIONS="--no-summary --no-progress" docs/cspell | \
          reviewdog \
            -efm='%f:%l:%c - %m' \
            -name="documents cspell" \
            -diff="git diff ${{ github.event.pull_request.base.ref }}" \
            -reporter=github-pr-review \
            -level=error
          make TEXTLINT_EXTRA_OPTIONS="-f checkstyle" docs/textlint | \
          reviewdog \
            -f=checkstyle \
            -name="documents testlint" \
            -diff="git diff ${{ github.event.pull_request.base.ref }}" \
            -reporter=github-pr-review \
            -level=error