Misc Documentation updates #105
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: Python checks | |
| permissions: | |
| contents: read | |
| on: | |
| push: | |
| branches: [main] | |
| paths: | |
| - compass/** | |
| - tests/** | |
| - .github/workflows/ci-python.yml | |
| - pyproject.toml | |
| - pixi.lock | |
| pull_request: | |
| paths: | |
| - compass/** | |
| - tests/** | |
| - .github/workflows/ci-python.yml | |
| - pyproject.toml | |
| - pixi.lock | |
| workflow_dispatch: | |
| jobs: | |
| lint: | |
| name: Lint Python Code Base with Ruff | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v6 | |
| - uses: astral-sh/ruff-action@v3 | |
| with: | |
| version: "latest" | |
| args: "check" | |
| src: "./compass" | |
| - uses: astral-sh/ruff-action@v3 | |
| with: | |
| version: "latest" | |
| args: "format --check" | |
| src: "./compass" | |
| locked-tests: | |
| needs: lint | |
| name: Pixi-Locked Unit Tests | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| max-parallel: 8 | |
| steps: | |
| - name: Checkout Repo | |
| uses: actions/checkout@v6 | |
| with: | |
| fetch-depth: 0 | |
| fetch-tags: true | |
| - uses: prefix-dev/setup-pixi@v0.9.3 | |
| with: | |
| pixi-version: v0.59.0 | |
| locked: true | |
| cache: true | |
| cache-write: false | |
| environments: pdev | |
| - run: | | |
| pixi reinstall -e pdev --locked NREL-COMPASS | |
| pixi run -e pdev --locked tests-u | |
| unit-tests: | |
| needs: lint | |
| name: Python Unit Tests (Pixi) | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| max-parallel: 8 | |
| matrix: | |
| os: [ubuntu-latest, macos-latest, windows-latest] | |
| steps: | |
| - name: Checkout Repo | |
| uses: actions/checkout@v6 | |
| with: | |
| fetch-depth: 0 | |
| fetch-tags: true | |
| - uses: prefix-dev/setup-pixi@v0.9.3 | |
| with: | |
| pixi-version: v0.59.0 | |
| locked: true | |
| cache: true | |
| cache-write: ${{ github.ref == 'refs/heads/main' }} | |
| environments: pdev | |
| - run: | | |
| pixi reinstall -e pdev NREL-COMPASS | |
| pixi run -e pdev tests-u | |
| integration-tests: | |
| needs: lint | |
| name: Python Integration Tests (Pixi) | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| max-parallel: 8 | |
| matrix: | |
| os: [ubuntu-latest, macos-latest, windows-latest] | |
| steps: | |
| - name: Checkout Repo | |
| uses: actions/checkout@v6 | |
| with: | |
| fetch-depth: 0 | |
| fetch-tags: true | |
| - uses: prefix-dev/setup-pixi@v0.9.3 | |
| with: | |
| pixi-version: v0.59.0 | |
| locked: true | |
| cache: true | |
| cache-write: false | |
| environments: pdev | |
| - run: | | |
| pixi reinstall -e pdev NREL-COMPASS | |
| pixi run -e pdev tests-i | |
| tox-tests: | |
| needs: lint | |
| name: Python tests (Tox) | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| max-parallel: 8 | |
| matrix: | |
| os: [ubuntu-latest, macos-latest] | |
| python-version: ['3.13', '3.12'] | |
| steps: | |
| - uses: actions/checkout@v6 | |
| with: | |
| fetch-depth: 0 | |
| fetch-tags: true | |
| - name: Set up Python ${{ matrix.python-version }} (with cache) | |
| if: github.ref == 'refs/heads/main' | |
| uses: actions/setup-python@v6 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| cache: 'pip' | |
| - name: Set up Python ${{ matrix.python-version }} (no cache) | |
| if: github.ref != 'refs/heads/main' | |
| uses: actions/setup-python@v6 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install Poppler Reqs (Linux) | |
| if: ${{ runner.os == 'Linux' }} | |
| shell: bash | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y libpoppler-cpp-dev poppler-utils | |
| - name: Install Poppler Reqs (Mac) | |
| if: ${{ runner.os == 'macOS' }} | |
| shell: bash | |
| run: | | |
| brew install poppler | |
| - name: Install Dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| python -m pip install tox tox-gh-actions>=2.0 | |
| python -m pip install pdftotext | |
| - name: Load tox cache | |
| uses: actions/cache/restore@v4 | |
| with: | |
| path: .tox/ | |
| key: ${{ runner.os }}-${{ matrix.python-version }}-tox-v1-${{ hashFiles('**/pyproject.toml') }} | |
| restore-keys: | | |
| ${{ runner.os }}-${{ matrix.python-version }}-tox-v1- | |
| - name: Test with tox | |
| run: tox -e ${{ matrix.python-version == '3.12' && 'msv' || 'latest' }} | |
| env: | |
| PYTHONDEVMODE: 1 | |
| - name: Save tox cache only on main | |
| if: github.ref == 'refs/heads/main' | |
| uses: actions/cache/save@v4 | |
| with: | |
| path: .tox/ | |
| key: ${{ runner.os }}-${{ matrix.python-version }}-tox-v1-${{ hashFiles('**/pyproject.toml') }} |