Use nox for environment automation #376
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 | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| schedule: | |
| # Run every Sunday | |
| - cron: "0 0 * * 0" | |
| workflow_dispatch: | |
| jobs: | |
| code-quality: | |
| name: Code Quality | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.11" | |
| - name: Install nox | |
| run: | | |
| pipx install nox | |
| - name: Lint | |
| run: | | |
| nox -s lint --verbose | |
| - name: Typecheck | |
| run: | | |
| nox -s typecheck --verbose | |
| tests: | |
| name: Tests (${{ matrix.os }}, Python ${{ matrix.python-version }}) | |
| needs: code-quality | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, macos-latest] # [ubuntu-latest, macos-latest, windows-latest] | |
| python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"] | |
| 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 nox | |
| run: | | |
| pipx install nox | |
| - name: Run tests | |
| run: | | |
| nox -s tests-${{ matrix.python-version }} --verbose | |
| - name: Upload coverage to codecov | |
| uses: codecov/codecov-action@v3 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| file: ./coverage.xml | |
| fail_ci_if_error: true | |
| if: ${{ matrix.os == 'ubuntu-latest' }} | |
| - name: Build distribution and test installation | |
| shell: bash | |
| run: | | |
| nox -s test_wheel-${{ matrix.python-version }} --verbose | |
| nox -s test_sdist-${{ matrix.python-version }} --verbose | |
| docs: | |
| name: Docs | |
| needs: code-quality | |
| if: github.event.pull_request != null | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.11" | |
| - name: Install nox | |
| run: | | |
| pipx install nox | |
| - name: Test building documentation | |
| run: | | |
| nox -s docs --verbose | |
| - name: Deploy site preview to Netlify | |
| uses: nwtgck/[email protected] | |
| with: | |
| publish-dir: "./docs/site" | |
| production-deploy: false | |
| github-token: ${{ secrets.GITHUB_TOKEN }} | |
| deploy-message: "Deploy from GitHub Actions" | |
| enable-pull-request-comment: true | |
| enable-commit-comment: false | |
| overwrites-pull-request-comment: true | |
| alias: deploy-preview-${{ github.event.number }} | |
| env: | |
| NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} | |
| NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }} | |
| timeout-minutes: 1 | |
| notify: | |
| name: Notify failed build | |
| needs: [code-quality, tests, docs] | |
| if: failure() && github.event.pull_request == null | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: jayqi/failed-build-issue-action@v1 | |
| with: | |
| github-token: ${{ secrets.GITHUB_TOKEN }} |