📝 several README.md improvements (#365)
#886
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: | |
| push: | |
| branches: | |
| - master | |
| pull_request: | |
| workflow_dispatch: | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }} | |
| cancel-in-progress: true | |
| jobs: | |
| lint: | |
| timeout-minutes: 1 | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: markdownlint | |
| uses: DavidAnson/markdownlint-cli2-action@v18 | |
| with: | |
| config: ".markdownlint.yaml" | |
| globs: "**/*.md" | |
| - name: typos | |
| uses: crate-ci/typos@master | |
| generate-matrix: | |
| name: Generate Test Matrix | |
| timeout-minutes: 1 | |
| runs-on: ubuntu-latest | |
| outputs: | |
| matrix: ${{ steps.set-matrix.outputs.matrix }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v5 | |
| - name: Install dependencies | |
| run: | | |
| uv sync --locked | |
| - name: Generate Matrix | |
| id: set-matrix | |
| shell: bash | |
| run: | | |
| matrix=$(uv run scripts/generate_matrix.py | jq -c) | |
| echo "matrix=$matrix" >> $GITHUB_OUTPUT | |
| typetest: | |
| needs: generate-matrix | |
| timeout-minutes: 3 | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: ${{ fromJSON(needs.generate-matrix.outputs.matrix) }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v5 | |
| with: | |
| enable-cache: true | |
| python-version: ${{ matrix.python }} | |
| - name: setup tox | |
| run: uv tool install tox --with tox-uv | |
| - name: Install dependencies | |
| continue-on-error: true | |
| run: | | |
| rm -rf .venv | |
| uv add --no-build-package=numpy "numpy<=${{ matrix.numpy }}" | |
| - name: Run typetest | |
| run: uv run tox -e=typetest | |
| - name: Run stubtest | |
| run: uv run tox -e=stubtest | |
| - name: lint | |
| run: uv run tox -e=lint | |
| - name: basedmypy | |
| run: uv run tox -e=mypy | |
| - name: basedpyright | |
| run: uv run tox -e=pyright |