Skip to content

README: document main as default branch #1

README: document main as default branch

README: document main as default branch #1

Workflow file for this run

name: Continuous integration tests
on:
push:
branches: [main]
pull_request:
branches: [main]
jobs:
ci:
name: CI
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
python-version: ["3.11", "3.12"]
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install package
run: |
python -m pip install --upgrade pip
pip install -e ".[dev,ui]"
- name: Ruff
run: ruff check src tests
- name: Pytest
run: pytest -q
docs:
name: Documentation (MkDocs)
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.12"
- name: Build docs
run: |
python -m pip install --upgrade pip
pip install -r docs/requirements.txt
mkdocs build
build-check:
name: Build and check package
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.12"
- name: Build and twine check
run: |
python -m pip install --upgrade pip build twine
python -m build
twine check dist/*