Added doctest to CI (#25) #59
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 template generation | |
| on: | |
| workflow_dispatch: | |
| pull_request: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| style: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.12 | |
| - name: Check style | |
| run: | | |
| python -m pip install pre-commit | |
| pre-commit run -a | |
| template_test: | |
| needs: style | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest, macos-13, macos-14, windows-latest] | |
| python-version: ["3.9", "3.10", "3.11", "3.12"] | |
| name: | |
| Template Tests (${{ matrix.os }} / Python ${{ matrix.python-version }}) | |
| steps: | |
| - name: Checkout pybamm-cookiecutter | |
| uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| id: setup-python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Set up uv | |
| uses: yezz123/setup-uv@v4 | |
| with: | |
| uv-venv: ".venv" | |
| - name: Install nox | |
| run: uv pip install nox[uv] | |
| - name: Test Template Generation | |
| run: | | |
| nox -s test-generation | |
| - name: Run coverage tests | |
| if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.12' | |
| run: python -m nox -s coverage | |
| - name: Upload coverage report | |
| if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.12' | |
| uses: codecov/[email protected] | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| run_doctests: | |
| needs: style | |
| runs-on: ubuntu-latest | |
| name: Doctests (ubuntu-latest / Python 3.12) | |
| steps: | |
| - name: Check out pybamm-cookiecutter repository | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.12 | |
| cache: 'pip' | |
| - name: Install nox | |
| run: python -m pip install nox | |
| - name: Check if the documentation can be built | |
| run: python -m nox -s docs |