Migrate to uv #932
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
| # SPDX-FileCopyrightText: Copyright DB InfraGO AG | |
| # SPDX-License-Identifier: CC0-1.0 | |
| name: Code QA | |
| on: | |
| pull_request: | |
| push: | |
| branches: [master] | |
| tags: ["v*.*.*"] | |
| workflow_dispatch: | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }}-${{ github.ref_type == 'tag' && github.sha || '0' }} | |
| cancel-in-progress: true | |
| jobs: | |
| test: | |
| name: Test with Python ${{matrix.python_version}} on ${{matrix.os}} | |
| runs-on: ${{matrix.os}} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest] | |
| python_version: | |
| - "3.10" | |
| - "3.11" | |
| - "3.12" | |
| include: | |
| - os: windows-latest | |
| python_version: "3.10" | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: astral-sh/setup-uv@v4 | |
| with: | |
| enable-cache: true | |
| cache-dependency-glob: "**/pyproject.toml" | |
| python-version: ${{matrix.python_version}} | |
| - name: Run unit tests | |
| run: uv run -m pytest --cov-report=term --cov=capellambse --rootdir=. | |
| pre-commit: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: astral-sh/setup-uv@v4 | |
| with: | |
| enable-cache: true | |
| cache-dependency-glob: "**/pyproject.toml" | |
| python-version: "3.12" | |
| - name: Run Pre-Commit | |
| run: uv run pre-commit run --all-files | |
| build: | |
| name: Build wheel | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: astral-sh/setup-uv@v4 | |
| with: | |
| enable-cache: true | |
| cache-dependency-glob: "**/pyproject.toml" | |
| python-version: "3.12" | |
| - name: Build packages | |
| run: uv build | |
| - name: Verify packages | |
| run: uvx twine check dist/* | |
| - name: Upload artifacts | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: python-package-distributions | |
| path: dist/ | |
| if-no-files-found: error | |
| - name: Push to release branch | |
| if: startsWith(github.ref, 'refs/tags/v') | |
| continue-on-error: true | |
| env: | |
| GITHUB_REF: ${{github.ref}} | |
| run: |- | |
| releasever="$(echo "$GITHUB_REF" | grep -Po '(?<=^refs/tags/v)(?:0\.)?[1-9][0-9]*').x" | |
| if [[ "$releasever" = 0.5.x ]]; then releasever="${releasever%.x}"; fi | |
| git push origin "HEAD:release-$releasever" | |
| pypi: | |
| name: Publish to PyPI | |
| runs-on: ubuntu-latest | |
| needs: [build, test, example-notebooks] | |
| if: startsWith(github.ref, 'refs/tags/v') | |
| environment: | |
| name: pypi | |
| url: https://pypi.org/project/capellambse | |
| permissions: | |
| id-token: write | |
| steps: | |
| - name: Download built wheel | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: python-package-distributions | |
| path: dist/ | |
| - name: Publish to PyPI | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| example-notebooks: | |
| name: Run and verify the example notebooks | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: astral-sh/setup-uv@v4 | |
| with: | |
| enable-cache: true | |
| cache-dependency-glob: "**/pyproject.toml" | |
| python-version: "3.12" | |
| - name: Run example notebooks | |
| run: | | |
| jq --version | |
| set -o pipefail | |
| export CAPELLAMBSE_UUID_SEED=0 | |
| ok=true | |
| function celloutputs() { | |
| jq -r '.cells[] | select(.cell_type=="code") | .outputs[] | (.text, .data["text/plain"]) | .[]?' < "$1" | | |
| grep -v '^$' | | |
| sed -e 's/ at 0x[0-9a-fA-F]\+/ at 0x0/' | |
| } | |
| for file in docs/source/examples/*.ipynb; do | |
| old_outputs="$(celloutputs "$file")" | |
| if ! uv run --all-extras jupyter nbconvert --to notebook --execute "$file" --output "${file##*/}" --ExecutePreprocessor.timeout "${NOTEBOOK_TIMEOUT_SEC:-300}"; then | |
| ok=false | |
| continue | |
| fi | |
| new_outputs="$(celloutputs "$file")" | |
| diff -u3 <(echo "$old_outputs") <(echo "$new_outputs") || ok=false | |
| done | |
| $ok | |
| docs: | |
| name: Build documentation | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: astral-sh/setup-uv@v4 | |
| with: | |
| enable-cache: true | |
| cache-dependency-glob: "**/pyproject.toml" | |
| python-version: "3.12" | |
| - name: Install system-level dependencies | |
| run: sudo apt-get install -y pandoc | |
| - name: Auto-generate APIDOC sources | |
| run: make -C docs apidoc | |
| - name: Create docs | |
| env: | |
| SPHINXOPTS: ${{ github.ref != 'refs/heads/master' && '-W' || '' }} | |
| run: make -C docs html | |
| - name: Upload built docs as artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: Documentation | |
| path: docs/build/html | |
| if-no-files-found: error | |
| retention-days: 5 | |
| - name: Deploy | |
| if: github.ref == 'refs/heads/master' | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| force_orphan: true | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs/build/html |