Fleshed out contributing docs to include pre-commit,style,build info #1497
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: Unit Tests | |
| on: | |
| push: | |
| pull_request: | |
| types: [opened, synchronize] | |
| defaults: | |
| run: | |
| shell: bash -l {0} | |
| jobs: | |
| unit-tests: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ["3.9", "3.10", "3.11", "3.12"] | |
| fail-fast: false | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Get full python version | |
| id: full-python-version | |
| run: echo "version=$(python -c "import sys; print('-'.join(str(v) for v in sys.version_info))")" >> $GITHUB_OUTPUT | |
| - name: Install poetry | |
| uses: abatilo/actions-poetry@v3 | |
| - name: Configure poetry | |
| run: | | |
| poetry config virtualenvs.create true --local | |
| poetry config virtualenvs.in-project true --local | |
| poetry self add setuptools | |
| - name: Set up cache | |
| uses: actions/cache@v4 | |
| id: cache | |
| with: | |
| path: .venv | |
| key: venv-${{ runner.os }}-${{ steps.full-python-version.outputs.version }}-${{ hashFiles('poetry.lock') }} | |
| - name: Ensure cache is healthy | |
| if: steps.cache.outputs.cache-hit == 'true' | |
| run: poetry run pip --version >/dev/null 2>&1 || rm -rf .venv | |
| - name: Install Dependencies | |
| if: ${{ !env.ACT }} | |
| run: poetry install | |
| - name: Install Dependencies | |
| if: ${{ env.ACT }} | |
| # When using `act` to run the workflow locally, the `poetry install` command | |
| # may fail due to network issues when running multiple Docker containers. | |
| run: poetry install || poetry install || poetry install | |
| - name: Test | |
| run: poetry run bash scripts/test.sh | |
| - name: Upload coverage | |
| # Don't upload coverage when using the `act` tool to run the workflow locally | |
| if: ${{ !env.ACT }} | |
| uses: codecov/codecov-action@v4 |