Skip to content

Created using Colab

Created using Colab #2

Workflow file for this run

name: Test and Document
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
test:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [3.9, "3.10", "3.11", "3.12"]
steps:
- uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Install system dependencies
run: |
sudo apt-get update
sudo apt-get install -y portaudio19-dev python3-dev
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install pytest pytest-cov black mypy
pip install -e ".[test,docs]"
- name: Run tests
run: |
pytest tests/ --cov=word_manifold --cov-report=xml
- name: Run type checks
run: |
mypy src/word_manifold
- name: Run style checks
run: |
black --check src/word_manifold tests
- name: Upload coverage
uses: codecov/codecov-action@v3
with:
file: ./coverage.xml
fail_ci_if_error: true
docs:
needs: test
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.12"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install mkdocs mkdocs-material mkdocstrings[python]
pip install -e ".[docs]"
- name: Build documentation
run: |
mkdocs build
- name: Deploy documentation
if: github.ref == 'refs/heads/main'
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site