ci.yml

name: CI

on: [push, pull_request]

env:
  PY_COLORS: "1"

jobs:
  test:
    runs-on: windows-latest
    strategy:
      matrix:
        python-version: [
          "3.8",
          "3.9",
          "3.10",
          "3.11",
          "3.12",
        ]
      fail-fast: false
    steps:
    - uses: actions/checkout@v4
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        python -m pip install pytest python-can==4.*
        python -m pip install .
    - name: Test
      run: |
        python -m pytest

  mypy:
    runs-on: windows-latest
    steps:
    - uses: actions/checkout@v4
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: "3.12"

    - name: Install dependencies
      run: |
        python -m pip install -e .[dev]

    - name: mypy 3.8
      run: |
        mypy --python-version 3.8 .
    - name: mypy 3.9
      run: |
        mypy --python-version 3.9 .
    - name: mypy 3.10
      run: |
        mypy --python-version 3.10 .
    - name: mypy 3.11
      run: |
        mypy --python-version 3.11 .
    - name: mypy 3.12
      run: |
        mypy --python-version 3.12 .

  linter:
    runs-on: windows-latest
    steps:
    - uses: actions/checkout@v4
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: "3.12"
    - name: Install dependencies
      run: |
        python -m pip install -e .[dev]
    - name: Run ruff
      run: |
        ruff check src

  format:
    runs-on: windows-latest
    steps:
    - uses: actions/checkout@v4
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: "3.12"
    - name: Install dependencies
      run: |
        python -m pip install -e .[dev]
    - name: Code Format Check with Black
      run: |
        black --check --verbose ./src

  build:
    name: Build artifacts
    runs-on: windows-latest
    steps:
      - uses: actions/checkout@v4

      - name: Build wheel and sdist
        run: pipx run build

      - name: Check artifacts
        run: pipx run twine check dist/*

      - uses: actions/upload-artifact@v4
        with:
          name: artifact
          path: dist/*

  docs:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: "3.10"
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -e .[doc]
    - name: Build documentation
      run: |
        python -m sphinx -Wan --keep-going docs build

  upload_pypi:
    name: Create release
    needs: [ mypy, linter, build, docs, format ]
    runs-on: ubuntu-latest
    environment:
      name: pypi
      url: https://pypi.org/p/pyCANape
    permissions:
      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
      contents: write  # for action-gh-release

    # create a new release for tagged commits
    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
    steps:
      - uses: actions/download-artifact@v4
        with:
          name: artifact
          path: dist

      - name: Publish package distributions to PyPI
        uses: pypa/gh-action-pypi-publish@release/v1

      - name: Release
        uses: softprops/action-gh-release@v2
        with:
          files: dist/*