Notebook docs support #27
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: format | |
| on: | |
| pull_request: | |
| branches: [main] | |
| jobs: | |
| format: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.12" | |
| - name: Install poetry | |
| uses: abatilo/actions-poetry@v2 | |
| with: | |
| poetry-version: "1.8.3" | |
| - name: Setup a local virtual environment | |
| run: | | |
| poetry config virtualenvs.create true --local | |
| poetry config virtualenvs.in-project true --local | |
| - uses: actions/cache@v3 | |
| name: Define a cache for the virtual environment based on the dependencies lock file | |
| with: | |
| path: ./.venv | |
| key: venv-${{ hashFiles('poetry.lock') }} | |
| - name: Install project dependencies | |
| run: poetry install | |
| # --- Ruff | |
| - name: ruff (lint) | |
| id: ruff_lint | |
| continue-on-error: true | |
| run: | | |
| poetry run ruff --version | |
| poetry run ruff check . --verbose --diff | |
| echo "ruff_lint_failed=$?" >> $GITHUB_ENV | |
| - name: ruff (format) | |
| id: ruff_format | |
| continue-on-error: true | |
| run: | | |
| poetry run ruff --version | |
| poetry run ruff format . --check --verbose --diff | |
| echo "ruff_format_failed=$?" >> $GITHUB_ENV | |
| # --- Pyright | |
| - name: pyright | |
| id: pyright | |
| continue-on-error: true | |
| run: | | |
| poetry run pyright --version | |
| poetry run pyright --project ./pyrightconfig.ci.json | |
| echo "pyright_failed=$?" >> $GITHUB_ENV | |
| # --- Main | |
| - name: Results | |
| if: always() | |
| run: | | |
| # Print out test results | |
| passed=() | |
| failed=() | |
| if [[ "${{ env.ruff_lint_failed }}" != "0" ]]; then | |
| failed+=("ruff_lint") | |
| else | |
| passed+=("ruff_lint") | |
| fi | |
| if [[ "${{ env.ruff_format_failed }}" != "0" ]]; then | |
| failed+=("ruff_format") | |
| else | |
| passed+=("ruff_format") | |
| fi | |
| if [[ "${{ env.pyright_failed }}" != "0" ]]; then | |
| failed+=("pyright") | |
| else | |
| passed+=("pyright") | |
| fi | |
| if [ ${#passed[@]} -ne 0 ]; then | |
| echo "✅ PASSED:" | |
| for check in "${passed[@]}"; do | |
| echo " - $check" | |
| done | |
| fi | |
| echo "" | |
| if [ ${#failed[@]} -ne 0 ]; then | |
| echo "❌ FAILED:" | |
| for check in "${failed[@]}"; do | |
| echo " - $check" | |
| done | |
| else | |
| echo "🚀🚀 ALL FORMATTING & TYPE-CHECKING PASSED 🚀🚀" | |
| fi | |
| echo "" | |
| echo "Click above jobs for details on each success/failure" | |
| if [ ${#failed[@]} -ne 0 ]; then | |
| exit 1 | |
| fi |