coding-style.yml

# This workflow will install and then lint the code with Flake8 and Pylint.
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python

name: Coding style

on:
  push:
    branches: ['master', 'devel']
  pull_request:
    branches: '*'

permissions:
  contents: read

jobs:
  Flake8:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        # Add the Python versions here to run tests on new(er) versions.
        python-version: ["3.11"]
    steps:
    - uses: actions/checkout@v3
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v3
      with:
        python-version: ${{ matrix.python-version }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install flake8
    - name: Lint with flake8
      run: |
        # stop the build if there are Python syntax errors or undefined names
        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
        # The GitHub editor is 127 chars wide
        flake8 . --count --statistics

  Pylint:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        # Add multiple Python versions here to run tests on new(er) versions.
        python-version: ["3.11"]
    steps:
    - uses: actions/checkout@v3
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v3
      with:
        python-version: ${{ matrix.python-version }}
    - name: Install dependencies
      run: |
        # Install same requirements as to be used during regression testing
        source $CONDA/etc/profile.d/conda.sh
        conda activate
        conda install -y -c conda-forge --file ./tests/requirements.txt
        # Install the package itself to make sure that all imports work.
        pip install .
    - name: Analysing the code with pylint
      run: |
        source $CONDA/etc/profile.d/conda.sh
        conda activate
        pylint $(git ls-files '*.py') --fail-under=7.0