fix: pypi readme #21
Workflow file for this run
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: Tests And Linting | |
| on: | |
| pull_request: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| validate: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.9" | |
| - name: Install Pre-Commit | |
| run: python -m pip install pre-commit && pre-commit install | |
| - name: Load cached Pre-Commit Dependencies | |
| id: cached-pre-commit-dependencies | |
| uses: actions/cache@v3 | |
| with: | |
| path: ~/.cache/pre-commit/ | |
| key: pre-commit|${{ env.pythonLocation }}|${{ hashFiles('.pre-commit-config.yaml') }} | |
| - name: Execute Pre-Commit | |
| run: pre-commit run --show-diff-on-failure --color=always --all-files | |
| test: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: true | |
| matrix: | |
| python-version: ["3.9", "3.10", "3.11", "3.12"] | |
| timeout-minutes: 30 | |
| defaults: | |
| run: | |
| shell: bash | |
| steps: | |
| - name: Check out repository | |
| uses: actions/checkout@v4 | |
| - uses: pdm-project/setup-pdm@v3 | |
| name: Set up PDM | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| cache: true | |
| - name: Install dependencies | |
| run: pdm install | |
| - name: Test | |
| run: pdm run pytest -m "" | |
| build-docs: | |
| needs: | |
| - validate | |
| if: github.event_name == 'pull_request' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out repository | |
| uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.12" | |
| - uses: pdm-project/setup-pdm@v3 | |
| name: Set up PDM | |
| with: | |
| python-version: "3.12" | |
| cache: true | |
| - name: Install dependencies | |
| run: pdm install -G:docs | |
| - name: Build docs | |
| run: pdm run make docs | |
| - name: Save PR number | |
| env: | |
| PR_NUMBER: ${{ github.event.number }} | |
| run: echo $PR_NUMBER > .pr_number | |
| - name: Upload artifact | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: docs-preview | |
| path: | | |
| docs/_build/html | |
| .pr_number |