Skip to content

Add github action to cover checks in code #2

Add github action to cover checks in code

Add github action to cover checks in code #2

Workflow file for this run

name: ci-checks
on: [push, pull_request]
jobs:
checks:
runs-on: ubuntu-latest
steps:
# =================================
# Check-out repo
# =================================
- name: Checkout code
uses: actions/checkout@v4
with:
persist-credentials: false
fetch-depth: 0
# =================================
# Set-up python
# =================================
- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: "3.10"
# =================================
# Install poetry
# =================================
- name: Install Poetry
uses: snok/install-poetry@v1
with:
virtualenvs-create: true
virtualenvs-in-project: true
installer-parallel: true
# =================================
# Load cached venv if cache exists
# =================================
- name: Load cached venv
id: cached-poetry-dependencies
uses: actions/cache@v3
with:
path: .venv
key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
# =================================
# Install poetry 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
# =================================
# Run mkdocs build
# =================================
- name: Run build
run: poetry run mkdocs build --strict
# =================================
# Run coverage
# =================================
- name: Run coverage
run: poetry run python -m pytest --cov=src --cov-report=html