Migrate CI workflow from Docker to native GitHub actions #851
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: CI | |
on: | |
workflow_call: | |
workflow_dispatch: | |
push: | |
branches: [master] | |
pull_request: | |
branches: [master] | |
schedule: | |
- cron: '30 16 * * 6' | |
jobs: | |
verify: | |
name: Check code formatting and run tests | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v4 | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: 3.x | |
- name: Install pre-commit | |
run: pip install pre-commit | |
- name: Check code formatting | |
run: pre-commit run --all-files | |
- name: Basic install to fetch dependencies for tests | |
run: pip install . | |
- name: Install test dependencies | |
run: pip install pytest setuptools | |
- name: Run tests | |
run : python3 -m unittest discover test | |
define-python-version-matrix: | |
name: Define Python versions matrix | |
needs: verify | |
runs-on: ubuntu-latest | |
outputs: | |
python-version: ${{ steps.python-version.outputs.python-version }} | |
steps: | |
- name: Define supported Python versions | |
id: python-version | |
run: | | |
echo 'python-version=["3.10", "3.11", "3.12", "3.13"]' >> "$GITHUB_OUTPUT" | |
build: | |
name: Build package | |
needs: define-python-version-matrix | |
runs-on: [ubuntu-latest] | |
strategy: | |
matrix: | |
python-version: ${{ fromJSON(needs.define-python-version-matrix.outputs.python-version) }} | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: ${{ matrix.python-version }} | |
- run: pip install build | |
- run: python -m build | |
pip-install: | |
name: Install package with pip | |
needs: define-python-version-matrix | |
runs-on: [ubuntu-latest] | |
strategy: | |
matrix: | |
python-version: ${{ fromJSON(needs.define-python-version-matrix.outputs.python-version) }} | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: ${{ matrix.python-version }} | |
- run: pip install build | |
- run: pip install . | |
pip-editable-install: | |
name: Install package in editable mode with pip | |
needs: define-python-version-matrix | |
runs-on: [ubuntu-latest] | |
strategy: | |
matrix: | |
python-version: ${{ fromJSON(needs.define-python-version-matrix.outputs.python-version) }} | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: ${{ matrix.python-version }} | |
- run: pip install build | |
- run: pip install -e . | |
build-docs: | |
name: Build documentation | |
needs: verify | |
runs-on: [ubuntu-latest] | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: 3.x | |
- name: install cflib | |
run: pip install . | |
- name: install pdoc3 | |
run: pip install pdoc3 | |
- name: build docs | |
run: pdoc3 docs/api/template |