Add licence header to convection tests #289
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: Pull request checks | |
| on: | |
| pull_request: | |
| push: | |
| branches: | |
| - "main" | |
| workflow_dispatch: | |
| jobs: | |
| tests: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| py-ver: ["py39", "py310", "py311", "py312"] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Cache conda environment | |
| id: conda-env-cache | |
| uses: actions/cache@v4 | |
| with: | |
| key: conda|${{runner.os}}-${{runner.arch}}|${{ hashFiles(format('requirements/locks/{0}-lock-linux-64.txt', matrix.py-ver)) }} | |
| path: ~/conda-env | |
| - name: Create conda environment | |
| if: steps.conda-env-cache.outputs.cache-hit != 'true' | |
| run: | | |
| # Check cache hasn't pulled a partial key match. | |
| test ! -e "${HOME}/conda-env" | |
| conda create --prefix="${HOME}/conda-env" --file=requirements/locks/${{ matrix.py-ver }}-lock-linux-64.txt | |
| - name: Add conda environment to PATH | |
| run: echo "${HOME}/conda-env/bin" >> $GITHUB_PATH | |
| - name: Run tests | |
| env: | |
| PY_COLORS: "1" | |
| run: | | |
| python3 -m pip install -e . | |
| pytest --verbose --cov --cov-append --cov-config=pyproject.toml | |
| mv .coverage ".coverage.${{ matrix.py-ver }}" | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: coverage-data-${{ matrix.py-ver }} | |
| path: .coverage.* | |
| retention-days: 1 | |
| coverage-report: | |
| if: github.event_name == 'pull_request' | |
| runs-on: ubuntu-latest | |
| needs: tests | |
| permissions: | |
| contents: read | |
| pull-requests: write | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.x" | |
| - name: Install coverage | |
| run: python3 -m pip install coverage | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| pattern: coverage-data-* | |
| merge-multiple: true | |
| - name: Generate coverage report | |
| run: | | |
| coverage combine | |
| coverage html | |
| - name: Add report to PR | |
| env: | |
| GH_TOKEN: ${{ github.token }} | |
| run: | | |
| # This links to a hosted version of the HTML report. | |
| tar -czf coverage-report.tar.gz htmlcov/ | |
| report_url="$(curl -sSf --data-binary @coverage-report.tar.gz https://tmpweb.net)" | |
| badge_options="$(coverage json --fail-under=0 -qo - | jq -r .totals.percent_covered_display)%25-blue?style=for-the-badge" | |
| echo "[](${report_url})" >> ${{ runner.temp }}/cov-report.md | |
| # Edit last comment if it exists, else create new one. | |
| if ! gh pr comment --edit-last ${{ github.head_ref }} --body-file ${{ runner.temp }}/cov-report.md ; then | |
| gh pr comment ${{ github.head_ref }} --body-file ${{ runner.temp }}/cov-report.md | |
| fi | |
| - name: Check 95% minimum coverage | |
| run: coverage report --fail-under=95 | |
| pre-commit: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.x" | |
| - uses: actions/cache@v4 | |
| with: | |
| key: pre-commit|${{runner.os}}-${{runner.arch}}|${{ env.pythonLocation }}|${{ hashFiles('.pre-commit-config.yaml') }} | |
| path: ~/.cache/pre-commit | |
| - name: Set up pre-commit | |
| run: python3 -m pip install pre-commit | |
| - name: Run pre-commit | |
| run: pre-commit run --show-diff-on-failure --color=always --all-files | |
| build-docs: | |
| if: github.event_name == 'pull_request' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Cache conda environment | |
| id: conda-env-cache | |
| uses: actions/cache@v4 | |
| with: | |
| key: conda|${{runner.os}}-${{runner.arch}}|${{hashFiles('requirements/locks/py312-lock-linux-64.txt')}} | |
| path: ~/conda-env | |
| - name: Create conda environment | |
| if: steps.conda-env-cache.outputs.cache-hit != 'true' | |
| run: | | |
| # Check cache hasn't pulled a partial key match. | |
| test ! -e "${HOME}/conda-env" | |
| conda create --prefix="${HOME}/conda-env" --file=requirements/locks/py312-lock-linux-64.txt | |
| - name: Add conda environment to PATH | |
| run: echo "${HOME}/conda-env/bin" >> $GITHUB_PATH | |
| - name: Build documentation with Sphinx | |
| run: | | |
| # Install module so it can be imported during docs generation. | |
| python3 -m pip install . | |
| # Generate the documentation | |
| sphinx-build -d "docs/build/doctree" "docs/source" "docs/build/html" --color -W -bhtml | |
| - name: Upload documentation artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: html-docs | |
| path: docs/build/html/ | |
| retention-days: 10 | |
| if-no-files-found: error |