pylint.yml

name: Pylint

on:
  push:
    branches:
      - '**'        # matches every branch
      - '!badges'   # excludes master
    paths:
      - pi_server/**
      - pylintrc
      - .github/workflows/**

jobs:
  build:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.10"]
    steps:
    - uses: actions/checkout@v3
      with:
        token: ${{ secrets.ACCESS_TOKEN }}
    - 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 pylint anybadge pdoc
        pip install -r pi_server/requirements.txt
    - name: create pylint badge
      run: |
        pylint --disable W1510 pi_server/ | tee pylint.txt
        score=$(sed -n 's/^Your code has been rated at \([-0-9.]*\)\/.*/\1/p' pylint.txt)
        anybadge -l pylint -v $score -f pylint.svg 2=red 4=orange 9=yellow 10=green
    - name: check linting
      id: linting
      run: |
        pylint --disable W1510 pi_server/ --fail-under 8
      continue-on-error: true
    - name: create documentation
      run: |
        pdoc -o docs/python_p2p_connector pi_server/p2p_connector
    - name: Archive code coverage results
      uses: stefanzweifel/git-auto-commit-action@v4
      with:
        commit_message: update pylint badge
        branch: badges
        commit_options: '--no-verify --signoff'
        create_branch: true
        push_options: '--force'
    - name: Check on failures
      if: steps.linting.outcome != 'success'
      run: exit 1