Skip to content

Replace Sphinx/ReadTheDocs with MkDocs + GitHub Pages #31

Replace Sphinx/ReadTheDocs with MkDocs + GitHub Pages

Replace Sphinx/ReadTheDocs with MkDocs + GitHub Pages #31

Workflow file for this run

name: pytest
on:
push:
release:
types:
- published
jobs:
test:
strategy:
max-parallel: 2
matrix:
python-version: ["3.13", "3.12"]
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v3
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
# pip does not read our setup.cfg...
pip install -e .[dev]
- name: test with pytest
run: pytest
build_sdist:
name: Build source distribution
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
name: Install Python
with:
python-version: '3.13'
- name: "install pypa-build"
run: |
python -m pip install --upgrade pip
pip install build
- name: Build sdist
run: python -m build
- uses: actions/upload-artifact@v4
with:
path: dist/*.tar.gz
upload_pypi:
needs: [test, build_sdist]
runs-on: ubuntu-latest
permissions:
# IMPORTANT: this permission is mandatory for trusted publishing
id-token: write
# upload to PyPI on every tag starting with 'v'
#if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags/v')
# alternatively, to publish when a GitHub Release is created, use the following rule:
if: github.event_name == 'release' && github.event.action == 'published'
steps:
- uses: actions/download-artifact@v4
with:
name: artifact
path: dist
- uses: pypa/gh-action-pypi-publish@release/v1
with:
name: Publish package distributions to PyPI