lint-on-pull-request.yaml

#********************************************************************************
# Copyright (c) 2022 Mercedes-Benz Tech Innovation GmbH
# Copyright (c) 2022 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Apache License, Version 2.0 which is available 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.
#
# SPDX-License-Identifier: Apache-2.0
#*******************************************************************************/

name: Markdown linting for documentation

on:
  pull_request:
    branches:
      - main

# This job will run markdown linting to ensure uniform .md style
jobs:
  lint:
    name: Run markdown lint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - uses: actions/setup-node@v3
        with:
          node-version: 16
          cache: npm

      - name: Install dependencies
        run: npm ci

      - name: Run markdown lint for docs folder
        run: npm run lint-doc

      - name: Run markdown lint for docs-kits folder
        run: npm run lint-kits