init repo #26
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_dispatch: | |
| pull_request: | |
| push: | |
| branches: | |
| - master | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| env: | |
| FORCE_COLOR: 3 | |
| jobs: | |
| lint: | |
| name: Format | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.x" | |
| - uses: pre-commit/[email protected] | |
| with: | |
| extra_args: --hook-stage manual --all-files | |
| - name: Run PyLint | |
| run: | | |
| echo "::add-matcher::$GITHUB_WORKSPACE/.github/matchers/pylint.json" | |
| pipx run nox -s pylint | |
| checks: | |
| name: Check Python ${{ matrix.python-version }} on ${{ matrix.runs-on }} | |
| runs-on: ${{ matrix.runs-on }} | |
| needs: [lint] | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: ["3.8", "3.12"] | |
| runs-on: [ubuntu-latest, macos-latest, windows-latest] | |
| include: | |
| - python-version: pypy-3.10 | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| allow-prereleases: true | |
| - name: Install package | |
| run: python -m pip install .[test] | |
| - name: Test package | |
| run: >- | |
| python -m pytest -ra --cov --cov-report=xml --cov-report=term | |
| --durations=20 | |
| - name: Upload coverage report | |
| uses: codecov/[email protected] | |
| docs: | |
| name: Check building docs | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 15 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| ref: ${{ github.head_ref }} | |
| - uses: wntrblm/[email protected] | |
| with: | |
| python-versions: "3.11" | |
| - name: Linkcheck | |
| run: nox -s docs -- -b linkcheck | |
| - name: Build docs with warnings as errors | |
| run: nox -s docs -- -W | |
| - name: Verify no changes required to API docs | |
| run: | | |
| nox -s build_api_docs | |
| git diff --exit-code | |
| pass: | |
| if: always() | |
| needs: [lint, checks, docs] | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 2 | |
| steps: | |
| - name: Decide whether the needed jobs succeeded or failed | |
| uses: re-actors/alls-green@release/v1 | |
| with: | |
| jobs: ${{ toJSON(needs) }} |