ci.yml

name: CI

on:
  push:
    branches:
      - main
  pull_request:
    branches_ignore: []

jobs:
  cancel-previous:
    runs-on: ubuntu-latest
    if: github.ref != 'refs/heads/main'
    steps:
      - uses: khan/pull-request-workflow-cancel@1.0.0
        with:
          workflows: "main.yml"
        env:
          GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'

  linting:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1

      - name: Install Python
        uses: actions/setup-python@v2
        with:
          python-version: "3.8"

      - name: Install dependencies
        run: |
            pip install -r requirements/test.txt
            pip freeze

      - name: Run linting tools
        run: |
          make lint

      - name: Comment PR
        if: github.event_name == 'pull_request' && failure()
        uses: marocchino/sticky-pull-request-comment@v1.1.0
        with:
          message: |
            - Please format your Python code with [black](https://black.readthedocs.io): `make black`
            - Please organize your imports [isorts](https://isort.readthedocs.io): `make isort`
            - Please ensure that your code passes [flake8](https://flake8.pycqa.org/en/latest/): `make flake8`

            You can trigger all lints locally by running `make lint`
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

  sphinx-docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1

      - name: Install Python
        uses: actions/setup-python@v2
        with:
          python-version: "3.8"

      - name: Install dependencies
        run: |
            pip install -r requirements/dev.txt
            pip freeze

      - name: Build documentation
        run: |
          cd docs
          make html

  testing:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version:
          - "3.8"
          - "3.9"
          - "3.10"
          - "3.11"
    needs: linting
    steps:
      - name: Install Python
        uses: actions/setup-python@v2
        with:
          python-version: ${{ matrix.python-version }}

      - name: Checkout repository
        uses: actions/checkout@v2
        with:
          lfs: true
          fetch-depth: 0

      - name: Install dependencies
        run: pip install -r requirements/test.txt; pip install --ignore-installed py

      - name: Run tests
        run: pytest
        env:
          DIFF_MAIN: ${{ github.event_name == 'pull_request' }}
          DIFF_LAST_COMMIT: ${{ github.ref == 'refs/heads/main' }}

      - name: Create text report
        run: coverage report

      - name: Coveralls
        uses: AndreMiras/coveralls-python-action@develop