lint.yaml

#
# lint.yaml
# Created by Perry Naseck on 6/28/21.
#
# Copyright (c) 2021, The CONIX Research Center
# All rights reserved.
#
# This source code is licensed under the BSD-3-Clause license found in the
# LICENSE file in the root directory of this source tree.
#

name: Lint
on: [push, pull_request]

jobs:
  markdown-link-check:
    name: Markdown Link Check
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - uses: gaurav-nelson/github-action-markdown-link-check@v1
  python-lint:
    name: Python lint ${{ matrix.name }} ${{ matrix.python-version }}
    runs-on: ubuntu-20.04
    strategy:
      fail-fast: false
      matrix:
        include:
          - { python-version: "3.8",  name: flake8,     cmd: flake8,                                                                                    }
          - { python-version: "3.9",  name: flake8,     cmd: flake8,                                                                                    }
          - { python-version: "3.10", name: flake8,     cmd: flake8,                                                                                    }
          - { python-version: "3.9",  name: pydocstyle, cmd: pydocstyle,                                                                                }
          - { python-version: "3.8",  name: pylint,     cmd: "pylint --extension-pkg-whitelist=vl53l5cx_py,cv2 --extension-pkg-allow-list=pyrealsense2" }
          - { python-version: "3.9",  name: pylint,     cmd: "pylint --extension-pkg-whitelist=vl53l5cx_py,cv2 --extension-pkg-allow-list=pyrealsense2" }
          - { python-version: "3.10", name: pylint,     cmd: "pylint --extension-pkg-whitelist=vl53l5cx_py,cv2 --extension-pkg-allow-list=pyrealsense2" }
          - { python-version: "3.9",  name: isort,      cmd: isort --check-only                                                                         }
          - { python-version: "3.9",  name: bandit,     cmd: bandit -r                                                                                  }
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-python@v4
        name: Install Python
        with:
          python-version: ${{ matrix.python-version }}
      - uses: actions/cache@v3
        with:
          path: ~/.cache/pip
          key: ${{ runner.os }}-${{ matrix.python-version }}-pip-${{ hashFiles('**/requirements.txt','**/setup.py','**/pyproject.toml') }}
          restore-keys: |
            ${{ runner.os }}-${{ matrix.python-version }}-pip-
      - name: Install Python Development and Realsense Dependencies
        run: python -m pip install -e .[dev,realsense,apriltag_detector]
        if: matrix.python-version != '3.10'
      - name: Install Python Development Dependencies
        run: python -m pip install -e .[dev,apriltag_detector]
        if: matrix.python-version == '3.10'
      - name: Ignore pyrealsense2
        run: printf "[TYPECHECK]\nignored-modules=pyrealsense2" > .pylintrc
        if: matrix.python-version == '3.10'
      - name: Run ${{ matrix.name }}
        run: python -m ${{ matrix.cmd }} arenarobot/