thesis notebooks #1
This file contains hidden or 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 | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: [main] | |
| schedule: | |
| # runs at 05:00 UTC on the 1st and 15th of each month. | |
| - cron: "0 5 1,15 * *" | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| defaults: | |
| run: | |
| # to fail on error in multiline statements (-e), in pipes (-o pipefail), and on unset variables (-u). | |
| shell: bash -euo pipefail {0} | |
| jobs: | |
| # Get the test environment from hatch as defined in pyproject.toml. | |
| # This ensures that the pyproject.toml is the single point of truth for test definitions and the same tests are | |
| # run locally and on continuous integration. | |
| # Check [[tool.hatch.envs.hatch-test.matrix]] in pyproject.toml and https://hatch.pypa.io/latest/environment/ | |
| get-environments: | |
| runs-on: ubuntu-latest | |
| outputs: | |
| envs: ${{ steps.get-envs.outputs.envs }} | |
| steps: | |
| - name: Clone repository code into the GitHub Actions runner | |
| uses: actions/checkout@v4 | |
| with: | |
| filter: blob:none | |
| fetch-depth: 0 | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v5 | |
| - name: Get test environments | |
| id: get-envs | |
| run: | | |
| ENVS_JSON=$(uvx hatch env show --json | jq -c 'to_entries | |
| | map( | |
| select(.key | startswith("hatch-test")) | |
| | { | |
| name: .key, | |
| label: (if (.key | contains("pre")) then .key + " (PRE-RELEASE DEPENDENCIES)" else .key end), | |
| python: .value.python | |
| } | |
| )') | |
| echo "envs=${ENVS_JSON}" | tee $GITHUB_OUTPUT | |
| # Run tests through hatch. Spawns a separate runner for each environment defined in the hatch matrix obtained above. | |
| test: | |
| needs: get-environments | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest] | |
| env: ${{ fromJSON(needs.get-environments.outputs.envs) }} | |
| name: ${{ matrix.env.label }} | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| filter: blob:none | |
| fetch-depth: 0 | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v5 | |
| with: | |
| python-version: ${{ matrix.env.python }} | |
| cache-dependency-glob: pyproject.toml | |
| - name: create hatch environment | |
| run: uvx hatch env create ${{ matrix.env.name }} | |
| - name: run tests using hatch | |
| env: | |
| MPLBACKEND: agg | |
| PLATFORM: ${{ matrix.os }} | |
| DISPLAY: :42 | |
| run: uvx hatch run ${{ matrix.env.name }}:run_cov | |
| - name: Upload coverage reports to Codecov | |
| uses: codecov/codecov-action@v5 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| # Check that all tests defined above pass. This makes it easy to set a single "required" test in branch | |
| # protection instead of having to update it frequently. See https://github.com/re-actors/alls-green#why. | |
| check: | |
| name: Tests pass in all hatch environments | |
| if: always() | |
| needs: | |
| - get-environments | |
| - test | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: re-actors/alls-green@release/v1 | |
| with: | |
| jobs: ${{ toJSON(needs) }} |