ci.yml

name: neoconfigen CI

on:
  pull_request:
    branches:
    - main

jobs:

  lint_with_flake8:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3
    - name: Set up Python 3.10
      uses: actions/setup-python@v4
      with:
        python-version: '3.10'
    - name: Install flake8
      run: |
        python -m pip install --upgrade pip
        pip install flake8
    - name: Lint with pylint
      run: |
        flake8 configen

  format_with_black_and_isort:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3
    - name: Set up Python 3.10
      uses: actions/setup-python@v4
      with:
        python-version: '3.10'
    - name: Install black
      run: |
        python -m pip install --upgrade pip
        pip install black isort
    - name: Format with black
      run: |
        python -m black --check configen
    - name: Format with isort
      run: |
        isort . --check --diff

  check_yaml:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3
    - name: Set up Python 3.10
      uses: actions/setup-python@v4
      with:
        python-version: '3.10'
    - name: Install pydocstyle
      run: |
        python -m pip install --upgrade pip
        pip install yamllint
    - name: Check docstrings with pydocstyle
      run: |
        yamllint .

  run_tests_and_type_checking:

    needs: [format_with_black_and_isort, lint_with_flake8, check_yaml]
    runs-on: ubuntu-latest

    steps:

    # ----------------------------------------------
    #  ----  check-out repo and set-up python ----
    # ----------------------------------------------
    - name: Check out repository
      uses: actions/checkout@v3
    - name: Set up Python 3.10
      uses: actions/setup-python@v4
      with:
        python-version: '3.10'

    # ----------------------------------------------
    #  -----  install & configure poetry  -----
    # ----------------------------------------------
    - name: Install Poetry
      uses: snok/install-poetry@v1.2
      with:
        virtualenvs-create: true
        virtualenvs-in-project: true
        installer-parallel: true

    # ----------------------------------------------
    # install dependencies if cache does not exist
    # ----------------------------------------------
    - name: Install dependencies
      if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
      run: poetry install --no-interaction --no-root

    # ----------------------------------------------
    #  -----  install and run pyright  -----
    # ----------------------------------------------
    - name: Setup node.js (for pyright)
      uses: actions/setup-node@v1
      with:
        node-version: "14"

    - name: Install pyright
      run: npm install -g pyright

    - name: Run type checking
      run: |
        poetry run pyright configen

    # ----------------------------------------------
    #  -----           Run Tests            -----
    # ----------------------------------------------
    - name: Test with pytest
      run: |
        poetry run python -m pytest -vv tests/