Build System: Pre-Commit, Docs and PyPi #3
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: Test pre-commit, code and docs | |
| on: | |
| pull_request: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| pre-commit: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.10" | |
| cache: "pip" | |
| cache-dependency-path: pyproject.toml | |
| - name: Test pre-commit hooks | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install pre-commit | |
| pre-commit run -a | |
| test_code: | |
| needs: [pre-commit] | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| max-parallel: 12 | |
| matrix: | |
| python-version: ["3.10"] | |
| os: [ubuntu-latest, windows-latest, macos-latest] | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| cache: "pip" | |
| cache-dependency-path: pyproject.toml | |
| - name: Install dependencies | |
| run: | | |
| pip install -e .[tests] | |
| - name: Test with pytest | |
| run: pytest | |
| test_code_coverage: | |
| runs-on: ubuntu-latest | |
| needs: [pre-commit] | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.10' | |
| - name: Install dependencies | |
| run: | | |
| pip install -e .[tests] | |
| - name: Test with pytest | |
| run: | | |
| pytest --cov=jaxwell tests | |
| - name: Upload coverage to Codecov | |
| uses: codecov/codecov-action@v3 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| fail_ci_if_error: false | |
| test_docs: | |
| runs-on: ubuntu-latest | |
| needs: [pre-commit] | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.10' | |
| cache: "pip" | |
| cache-dependency-path: pyproject.toml | |
| - name: Install dependencies | |
| run: | | |
| make dev | |
| - name: Test documentation | |
| run: | | |
| make docs |