lint_markdown.yml

name: Markdown documents lint

defaults:
  run:
    shell: bash

on:
  push:
    branches:
      - master
      - develop
    paths:
      - '**/*.md'

  pull_request:
    branches:
      - master
      - develop
    paths:
      - '**/*.md'

jobs:
  lint-markdown:
    runs-on: ubuntu-20.04
    name: Lint job
    steps:
      - uses: actions/checkout@v2
        with:
          fetch-depth: 0
      - name: Add scripts to the PATH
        run: echo "${{ github.workspace }}/resources/ci_cd/" >> $GITHUB_PATH
      - name: Set up Node
        uses: actions/setup-node@v2-beta
        with:
          node-version: '14'
      - name: Set up Python
        uses: actions/setup-python@v2
        with:
          python-version: 3.7
      - name: Install necessary tools
        run: |
          npm install markdownlint-cli@0.23.1
      - name: Perform format check in a pull request
        if: github.event_name == 'pull_request'
        working-directory: ${{ github.workspace }}
        run: |
          base_commit="${{ github.event.pull_request.base.sha }}"
          head_commit="${{ github.event.pull_request.head.sha }}"
          linux_format.py -py -clang -r "${base_commit}...${head_commit}"
      - name: Perform format check in normal push
        if: github.event_name == 'push'
        working-directory: ${{ github.workspace }}
        run: linux_format.py -py -clang -a