ci.yml

# matrixctl
# Copyright (c) 2020  Michael Sasser <Michael@MichaelSasser.org>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
---
name: Python CI

on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master, develop ]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4.1.7
      - name: Set up Python 3.11
        uses: actions/setup-python@v5.2.0
        with:
          python-version: "3.11"

      - name: Install Poetry
        uses: snok/install-poetry@v1.4
        with:
          virtualenvs-create: true
          virtualenvs-in-project: true

      - name: Load cached venv
        id: cached-poetry-dependencies
        uses: actions/cache@v4.0.2
        with:
          path: .venv
          key: venv-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}

      - name: Install Project Dependencies
        run: poetry install --with docs
        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'

      - name: Run pre-commit
        run: |
          source .venv/bin/activate
          pre-commit run --all-files

      - name: Sphinx Build
        working-directory: ./docs
        run: |
          source ../.venv/bin/activate
          make html

      - name: Test with pytest
        run: |
          source .venv/bin/activate
          poetry run pytest