linter.yml

# =============================================================================
# Workflow for linting
#
# Objective:
#   - Install python dependencies
#   - Run linter
#
# Version: 0.1.1
#
# Author: Diptesh
#
# Date: Feb 14, 2024
# =============================================================================

name: linter

on:
  push:
    branches:
      - 'stable'
      - 'testing'
      - 'feature*'
      - 'bug*'
      - 'maintenance*'
  pull_request:
    branches:
      - 'stable'
      - 'testing'
      - 'feature*'
      - 'bug*'
      - 'maintenance*'

jobs:
  build:

    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        python-version: ['3.10']

    steps:
    - uses: actions/checkout@v2
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v2
      with:
        python-version: ${{ matrix.python-version }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        python -m pip install flake8 pytest
        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
    - name: Lint with flake8
      run: |
        # stop the build if there are Python syntax errors or undefined names
        flake8 . --count --extend-ignore=E402,W0511 --show-source --statistics
        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics