Skip to content

README.md

Latest commit

 

History

History
103 lines (79 loc) · 3.87 KB

README.md

File metadata and controls

103 lines (79 loc) · 3.87 KB

setup-uv-python

Composite action for installing Python via uv. uv itself is also installed, via astral-sh/setup-uv.

Requirements

  • bash must be present on the runner image (all run steps here use shell: bash).

Inputs

Input Required Default Description
python-version Yes N/A Python version to install.
summary-label No '' Optional label for step summary output.
uv-version No 0.10.10 uv version to install.
enable-cache No true Enable uv cache restore/save behavior.
cache-python No true Cache uv-managed Python installations.
cache-dependency-glob No '' Files used by setup-uv to compute cache keys.
cache-suffix No '' Optional suffix for cache busting/debugging.
add-python-to-path No true Add the venv binary directory to PATH.
export-python-env No true Export PYTHON_BIN and VIRTUAL_ENV.

Outputs

Output Description
python-bin Full path to the selected Python interpreter in the CI venv.

Ways to run Python from within the workflow

  • python (when add-python-to-path is true)
  • python3 (when add-python-to-path is true)
  • ${{ steps.<setup_step_id>.outputs.python-bin }} (always)
  • $PYTHON_BIN (Bash) or & $env:PYTHON_BIN -m (PowerShell) when export-python-env is true

Environment changes (default behavior)

So long as add-python-to-path and export-python-env are true, which they are by default, the following environment changes are made:

  • Exports PYTHON_BIN and VIRTUAL_ENV for subsequent steps.
  • Updates PATH to include the venv binary directory.

Usage example

- name: Set up uv-managed Python
  id: setup_python
  # Recommended: pin to an immutable commit SHA.
  uses: google-ml-infra/actions/setup-uv-python@<SHA>
  # Optional while iterating: use a branch or tag instead of a SHA.
  # uses: google-ml-infra/actions/setup-uv-python@main
  with:
    python-version: '3.12'
    summary-label: 'unit-tests' # optional
    cache-dependency-glob: |    # optional
      pyproject.toml
      uv.lock

- name: Install dependencies
  run: uv pip install -r requirements.txt

- name: Run tests
  run: |
    python -m pytest
    python3 -c "import sys; print(sys.version)"

If the default behavior of exporting PYTHON_BIN+VIRTUAL_ENV, or adding the bin directory to PATH is not desired, set add-python-to-path and/or export-python-env to false.

- name: Set up uv-managed Python without PATH/env exports
  id: setup_python
  uses: google-ml-infra/actions/setup-uv-python@<SHA>
  with:
    python-version: '3.12'
    add-python-to-path: 'false'
    export-python-env: 'false'

- run: ${{ steps.setup_python.outputs.python-bin }} -m pytest

Step Summary Output

Debug information about the timing and the installation (e.g., cache usage) may be output in the form of a step summary.

  • Step-summary output is emitted only when CI_UV_DEBUG=true.
  • If summary-label is empty, a default of python-<python-version> is used.
  • If the action is invoked multiple times within the same job, for the same python version, set summary-label explicitly for each invocation to keep step-summary entries unambiguous.

Notes

  • If cache-dependency-glob is empty, setup-uv default dependency globs are used.