Set docs docstring_style
#2985
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: Tests | |
| on: | |
| pull_request: | |
| branches: [main] | |
| push: | |
| branches: [main] | |
| jobs: | |
| style: | |
| name: Check the code style | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.10" | |
| - uses: pre-commit/[email protected] | |
| tests: | |
| name: Run the tests | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ["3.10"] | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Set up test environment | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -e .[test] | |
| - name: Create matrix id | |
| id: matrix-id | |
| env: | |
| MATRIX_CONTEXT: ${{ toJson(matrix) }} | |
| run: | | |
| echo $MATRIX_CONTEXT | |
| export MATRIX_ID=`echo $MATRIX_CONTEXT | md5sum | cut -c 1-32` | |
| echo $MATRIX_ID | |
| echo "::set-output name=id::$MATRIX_ID" | |
| - name: Run tests | |
| run: | | |
| pytest -x --cov=outlines | |
| env: | |
| COVERAGE_FILE: .coverage.${{ steps.matrix-id.outputs.id }} | |
| - name: Upload coverage data | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: coverage-data | |
| path: .coverage.* | |
| if-no-files-found: ignore | |
| include-hidden-files: true | |
| # TODO FIXME: This is only using the last run | |
| overwrite: true | |
| coverage: | |
| name: Combine & check coverage. | |
| needs: tests | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| cache: pip | |
| python-version: "3.11" | |
| - name: Set up environment | |
| run: | | |
| pip install --upgrade "coverage[toml]>=5.1" diff-cover | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| name: coverage-data | |
| - name: Fetch main for coverage diff | |
| run: | | |
| git fetch --no-tags --prune origin main | |
| - name: Combine coverage & fail if it's <100%. | |
| run: | | |
| python -m coverage combine | |
| python -m coverage html --skip-covered --skip-empty | |
| python -m coverage xml | |
| diff-cover coverage.xml --markdown-report=coverage.md --fail-under=100 || (cat coverage.md >> $GITHUB_STEP_SUMMARY && exit 1) | |
| - name: Upload HTML report if check failed. | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: html-report | |
| path: htmlcov | |
| # TODO FIXME: This is only using the last run | |
| overwrite: true | |
| if: ${{ failure() }} | |
| build-wheel: | |
| name: Build Wheel and Test SDist | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Build SDist and Wheel | |
| run: ./.github/scripts/build_sdist_and_wheel.sh |