Use nox to generate test matrix #1899
Workflow file for this run
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: Tests | |
| on: | |
| push: | |
| branches: | |
| - "**" | |
| paths: | |
| - "src/**" | |
| - "tests/**" | |
| - "docs/**" | |
| - "pyproject.toml" | |
| - "uv.lock" | |
| - ".pre-commit-config.yaml" | |
| - "noxfile.py" | |
| - ".github/workflows/tests.yml" | |
| jobs: | |
| generate-jobs: | |
| runs-on: ubuntu-latest | |
| outputs: | |
| session: ${{ steps.set-matrix.outputs.session }} | |
| steps: | |
| - uses: actions/checkout@v6 | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v7 | |
| - id: set-matrix | |
| run: echo session=$(uvx nox@2025.11.12 --json -l | jq -c '[.[].session]') | tee --append $GITHUB_OUTPUT | |
| tests: | |
| name: ${{ matrix.session }} | |
| needs: [generate-jobs] | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| session: ${{ fromJson(needs.generate-jobs.outputs.session) }} | |
| env: | |
| NOXSESSION: ${{ matrix.session }} | |
| FORCE_COLOR: "1" | |
| PRE_COMMIT_COLOR: "always" | |
| steps: | |
| - name: Check out the repository | |
| uses: actions/checkout@v6 | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v7 | |
| with: | |
| enable-cache: true | |
| - name: Compute pre-commit cache key | |
| if: matrix.session == 'pre-commit' | |
| id: pre-commit-cache | |
| shell: python | |
| run: | | |
| import hashlib | |
| import subprocess | |
| import sys | |
| python = "py{}.{}".format(*sys.version_info[:2]) | |
| payload = sys.version.encode() + sys.executable.encode() | |
| digest = hashlib.sha256(payload).hexdigest() | |
| result = "${{ runner.os }}-{}-{}-pre-commit".format(python, digest[:8]) | |
| cmd = f'echo "result={result}" >> $GITHUB_OUTPUT' | |
| subprocess.run(cmd, shell=True) | |
| - name: Restore pre-commit cache | |
| uses: actions/cache@v5 | |
| if: matrix.session == 'pre-commit' | |
| with: | |
| path: ~/.cache/pre-commit | |
| key: ${{ steps.pre-commit-cache.outputs.result }}-${{ hashFiles('.pre-commit-config.yaml') }} | |
| restore-keys: | | |
| ${{ steps.pre-commit-cache.outputs.result }}- | |
| - name: Run Nox | |
| run: | | |
| uvx nox@2025.11.12 --python=${{ matrix.python }} | |
| - name: Upload coverage data | |
| if: always() && matrix.session == 'tests' | |
| uses: "actions/upload-artifact@v6" | |
| with: | |
| name: coverage-data-${{ matrix.os }}-${{ matrix.python }} | |
| path: ".coverage.*" | |
| include-hidden-files: true | |
| - name: Upload documentation | |
| if: matrix.session == 'docs-build' | |
| uses: actions/upload-artifact@v6 | |
| with: | |
| name: docs | |
| path: docs/_build | |
| coverage: | |
| runs-on: ubuntu-latest | |
| needs: tests | |
| steps: | |
| - name: Check out the repository | |
| uses: actions/checkout@v6 | |
| with: | |
| fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v7 | |
| with: | |
| enable-cache: true | |
| - name: Download coverage data | |
| uses: actions/download-artifact@v7 | |
| with: | |
| pattern: coverage-data-* | |
| merge-multiple: true | |
| - name: Combine coverage data and display human readable report | |
| run: | | |
| uvx nox@2025.11.12 --session=coverage | |
| - name: Create coverage report | |
| run: | | |
| uvx nox@2025.11.12 --session=coverage -- xml | |
| # Need to fix coverage source paths for SonarCloud scanning in GitHub actions. | |
| # Replace root path with /github/workspace (mounted in docker container). | |
| - name: Override coverage source paths for SonarCloud | |
| run: | | |
| sed -i "s/<source><\/source>/<source>\/home\/runner\/work\/datadoc\/datadoc<\/source>/g" coverage.xml | |
| sed -i "s/<source>tests/<source>\/home\/runner\/work\/datadoc\/datadoc\/tests/g" coverage.xml | |
| - name: SonarQube Cloud Scan | |
| env: | |
| SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} | |
| # No need to run SonarCloud analysis if dependabot update or token not defined | |
| if: env.SONAR_TOKEN != '' && (github.actor != 'dependabot[bot]') | |
| uses: SonarSource/sonarqube-scan-action@v7.0.0 |