kiwitcms/Kiwi

View on GitHub
.github/workflows/lint.yml

Summary

Maintainability
Test Coverage
name: lint

on:
  push:
    branches: master
  pull_request:

permissions: read-all

jobs:
  doc8:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: [3.11]

    steps:
    - uses: actions/checkout@v4
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}
    - name: Lint with doc8
      run: |
        pip install doc8
        make doc8

  flake8:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: [3.11]

    steps:
    - uses: actions/checkout@v4
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}
    - name: Lint with flake8
      run: |
        pip install flake8
        make flake8

  # this still contains failures
  pylint:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: [3.11]

    steps:
    - uses: actions/checkout@v4
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}
    - name: Lint with pylint
      run: |
        pip install -r requirements/devel.txt

        export LANG=en-us
        make pylint

  pylint_site_packages:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: [3.11]

    steps:
    - uses: actions/checkout@v4
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}
    - name: Lint with pylint
      run: |
        pip install -r requirements/mariadb.txt
        pip install -r requirements/postgres.txt
        pip install -r requirements/devel.txt

        make pylint_site_packages

  similar_strings:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: [3.11]

    steps:
    - uses: actions/checkout@v4
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}
    - name: Lint with pylint
      run: |
        pip install -r requirements/devel.txt

        export LANG=en-us
        make similar_strings

  isort:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: [3.11]

    steps:
    - uses: actions/checkout@v4
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}
    - name: isort --check
      run: |
        pip install -r requirements/devel.txt

        export LANG=en-us
        # skip kiwi_lint/__init__.py b/c the import order is used to easily
        # figure out pylint numerical IDs by looking at the last import !!!
        isort --check --color --diff --skip kiwi_lint/__init__.py .

  black:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: [3.11]

    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
      - uses: psf/black@24.4.0

  eslint:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
      - name: Run eslint
        run: |
          cd tcms/
          ./npm-install && npm install --dev

          ./node_modules/.bin/eslint .