Fill out sections #61
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
| # Run static analysis, tests, and sync | |
| name: "ci" | |
| concurrency: | |
| group: "${{ github.workflow }}-${{ github.ref }}" | |
| cancel-in-progress: True | |
| on: | |
| workflow_dispatch: | |
| pull_request: | |
| push: | |
| branches: ["main"] | |
| defaults: | |
| run: | |
| shell: "pwsh" | |
| env: | |
| UV_CACHE_DIR: ".cache/uv-cache" | |
| UV_SYSTEM_PYTHON: "true" | |
| jobs: | |
| sync: | |
| strategy: | |
| matrix: | |
| runner: ["ubuntu-22.04"] | |
| python: ["3.11"] | |
| runs-on: "${{ matrix.runner }}" | |
| steps: | |
| - uses: "actions/checkout@1d96c772d19495a3b5c517cd2bc0cb401ea0529f" # v4.1.3 | |
| with: | |
| submodules: True | |
| - uses: "actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d" # v5.1.0 | |
| with: | |
| python-version: "${{ matrix.python }}" | |
| - run: "scripts/Sync-Py.ps1" | |
| - uses: "actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808" # v4.3.3 | |
| with: | |
| name: "lock" | |
| path: "lock.json" | |
| - uses: "actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9" # v4.0.2 | |
| with: | |
| path: "${{ env.UV_CACHE_DIR }}" | |
| key: "uv-${{ matrix.runner }}-${{ matrix.python }}-${{ hashFiles('lock.json') }}" | |
| build-docs: | |
| needs: "sync" | |
| strategy: | |
| matrix: | |
| runner: ["ubuntu-22.04"] | |
| python: ["3.11"] | |
| runs-on: "${{ matrix.runner }}" | |
| steps: | |
| - uses: "actions/checkout@1d96c772d19495a3b5c517cd2bc0cb401ea0529f" # v4.1.3 | |
| with: | |
| submodules: True | |
| - uses: "actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e" # v4.1.7 | |
| with: | |
| name: "lock" | |
| - uses: "actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9" # v4.0.2 | |
| with: | |
| path: "${{ env.UV_CACHE_DIR }}" | |
| key: "uv-${{ matrix.runner }}-${{ matrix.python }}-${{ hashFiles('lock.json') }}" | |
| - uses: "actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d" # v5.1.0 | |
| with: | |
| python-version: "${{ matrix.python }}" | |
| - run: "scripts/Sync-Py.ps1" | |
| - run: "sphinx-build -EaT docs _site" | |
| - uses: "actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa" # v3.0.1 | |
| deploy-docs: | |
| if: github.event_name != 'pull_request' | |
| needs: "build-docs" | |
| permissions: | |
| pages: "write" | |
| id-token: "write" | |
| strategy: | |
| matrix: | |
| runner: ["ubuntu-22.04"] | |
| python: ["3.11"] | |
| environment: | |
| name: "github-pages" | |
| url: "${{ steps.deployment.outputs.page_url }}" | |
| runs-on: "${{ matrix.runner }}" | |
| steps: | |
| - id: "deployment" | |
| uses: "actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e" # v4.0.5 | |
| ruff: | |
| needs: "sync" | |
| strategy: | |
| matrix: | |
| runner: ["ubuntu-22.04"] | |
| python: ["3.11"] | |
| runs-on: "${{ matrix.runner }}" | |
| steps: | |
| - uses: "actions/checkout@1d96c772d19495a3b5c517cd2bc0cb401ea0529f" # v4.1.3 | |
| with: | |
| submodules: True | |
| - uses: "actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e" # v4.1.7 | |
| with: | |
| name: "lock" | |
| - uses: "actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9" # v4.0.2 | |
| with: | |
| path: "${{ env.UV_CACHE_DIR }}" | |
| key: "uv-${{ matrix.runner }}-${{ matrix.python }}-${{ hashFiles('lock.json') }}" | |
| - uses: "actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d" # v5.1.0 | |
| with: | |
| python-version: "${{ matrix.python }}" | |
| - run: "scripts/Sync-Py.ps1" | |
| - run: "ruff check --no-fix --output-format github ." | |
| fawltydeps: | |
| needs: "sync" | |
| strategy: | |
| matrix: | |
| runner: ["ubuntu-22.04"] | |
| python: ["3.11"] | |
| runs-on: "${{ matrix.runner }}" | |
| steps: | |
| - uses: "actions/checkout@1d96c772d19495a3b5c517cd2bc0cb401ea0529f" # v4.1.3 | |
| with: | |
| submodules: True | |
| - uses: "actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e" # v4.1.7 | |
| with: | |
| name: "lock" | |
| - uses: "actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9" # v4.0.2 | |
| with: | |
| path: "${{ env.UV_CACHE_DIR }}" | |
| key: "uv-${{ matrix.runner }}-${{ matrix.python }}-${{ hashFiles('lock.json') }}" | |
| - uses: "actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d" # v5.1.0 | |
| with: | |
| python-version: "${{ matrix.python }}" | |
| - run: "scripts/Sync-Py.ps1" | |
| - run: "fawltydeps" | |
| pyright: | |
| needs: "sync" | |
| strategy: | |
| matrix: | |
| runner: ["ubuntu-22.04"] | |
| python: ["3.11"] | |
| runs-on: "${{ matrix.runner }}" | |
| steps: | |
| - uses: "actions/checkout@1d96c772d19495a3b5c517cd2bc0cb401ea0529f" # v4.1.3 | |
| with: | |
| submodules: True | |
| - uses: "actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e" # v4.1.7 | |
| with: | |
| name: "lock" | |
| - uses: "actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9" # v4.0.2 | |
| with: | |
| path: "${{ env.UV_CACHE_DIR }}" | |
| key: "uv-${{ matrix.runner }}-${{ matrix.python }}-${{ hashFiles('lock.json') }}" | |
| - uses: "actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d" # v5.1.0 | |
| with: | |
| python-version: "${{ matrix.python }}" | |
| - run: "scripts/Sync-Py.ps1" | |
| - run: pyright | |
| test: | |
| needs: "sync" | |
| strategy: | |
| matrix: | |
| runner: | |
| - "macos-14" | |
| - "ubuntu-22.04" | |
| - "windows-2022" | |
| python: | |
| # - "3.10" # ? `scripts` currently requires `tomllib`, which is > 3.10 | |
| - "3.11" | |
| # - "3.12" # ? No support in my commit-pinned fork of cachier | |
| # - "3.13.0-alpha.5" # ? https://github.com/PyO3/pyo3/issues/3555 | |
| runs-on: "${{ matrix.runner }}" | |
| steps: | |
| - uses: "actions/checkout@1d96c772d19495a3b5c517cd2bc0cb401ea0529f" # v4.1.3 | |
| with: | |
| submodules: True | |
| - uses: "actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e" # v4.1.7 | |
| with: | |
| name: "lock" | |
| - uses: "actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9" # v4.0.2 | |
| with: | |
| path: "${{ env.UV_CACHE_DIR }}" | |
| key: "uv-${{ matrix.runner }}-${{ matrix.python }}-${{ hashFiles('lock.json') }}" | |
| - uses: "actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d" # v5.1.0 | |
| with: | |
| python-version: "${{ matrix.python }}" | |
| - run: "scripts/Sync-Py.ps1 -Version '${{ matrix.python }}'" | |
| # ! https://github.com/pytest-dev/pytest-cov/issues/479#issuecomment-1247444988 | |
| - run: "pytest --cov --cov-config pyproject.toml" | |
| - if: startsWith(matrix.runner, 'ubuntu') && matrix.python == '3.11' | |
| uses: "codecov/codecov-action@84508663e988701840491b86de86b666e8a86bed" # v4.3.0 | |
| env: | |
| CODECOV_TOKEN: "${{ secrets.CODECOV_TOKEN }}" | |
| lock: | |
| needs: | |
| - "ruff" | |
| - "fawltydeps" | |
| - "pyright" | |
| - "test" | |
| permissions: | |
| contents: "write" | |
| strategy: | |
| matrix: | |
| runner: ["ubuntu-22.04"] | |
| python: ["3.11"] | |
| runs-on: "${{ matrix.runner }}" | |
| steps: | |
| - uses: "actions/checkout@1d96c772d19495a3b5c517cd2bc0cb401ea0529f" # v4.1.3 | |
| with: | |
| submodules: True | |
| - uses: "actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e" # v4.1.7 | |
| with: | |
| name: "lock" | |
| - uses: "actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9" # v4.0.2 | |
| with: | |
| path: "${{ env.UV_CACHE_DIR }}" | |
| key: "uv-${{ matrix.runner }}-${{ matrix.python }}-${{ hashFiles('lock.json') }}" | |
| - uses: "actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d" # v5.1.0 | |
| with: | |
| python-version: "${{ matrix.python }}" | |
| - run: "scripts/Sync-Py.ps1" | |
| - uses: "stefanzweifel/git-auto-commit-action@8621497c8c39c72f3e2a999a26b4ca1b5058a842" # v5.0.1 | |
| with: | |
| commit_message: "Sync and lock" |