mirror of
https://github.com/astral-sh/setup-uv.git
synced 2026-06-19 11:02:23 +00:00
somaz
3faa3174e6
Adds `uv.lock` as a supported `version-file` source. When `uv` is locked as a dependency in `uv.lock`, the action now installs the exact pinned version, closing the gap reported in #682. This is useful for deterministic CI: the same uv version is used until the lockfile is updated, which avoids "CI worked yesterday, fails today" drift and reduces supply-chain exposure from auto-installing the latest release. The implementation mirrors the existing `version-file` parsers — a new `uv.lock` entry in the parser registry reads the `[[package]]` whose `name = "uv"` and returns its locked `version`. Scoped to explicit `version-file: uv.lock`; workspace auto-detection is left as a possible follow-up to avoid precedence ambiguity with `uv.toml` / `pyproject.toml`. Validation (local, Node 23; dist build is esbuild-deterministic): - `npm run all` → build clean, biome clean, package clean, jest 77/77 - New tests: 3 unit (`uv-lock-file.test.ts`) + 1 integration — exact pin resolves through the full pipeline (`uv.lock` → `0.8.17`) - dist rebuilt + committed (single bundle, no spurious churn) related: #682
120 lines
4.2 KiB
YAML
120 lines
4.2 KiB
YAML
name: "astral-sh/setup-uv"
|
|
description:
|
|
"Set up your GitHub Actions workflow with a specific version of uv."
|
|
author: "astral-sh"
|
|
inputs:
|
|
version:
|
|
description: "The version of uv to install e.g., `0.5.0` Defaults to the version in pyproject.toml or 'latest'."
|
|
default: ""
|
|
version-file:
|
|
description: "Path to a file containing the version of uv to install, e.g., uv.toml, pyproject.toml, .tool-versions, requirements.txt or uv.lock. Defaults to searching for uv.toml and if not found pyproject.toml."
|
|
default: ""
|
|
python-version:
|
|
description: "The version of Python to set UV_PYTHON to"
|
|
required: false
|
|
activate-environment:
|
|
description: "Use uv venv to activate a venv ready to be used by later steps. "
|
|
default: "false"
|
|
venv-path:
|
|
description: "Custom path for the virtual environment when using activate-environment. Defaults to '.venv' in the working directory."
|
|
default: ""
|
|
no-project:
|
|
description: "Pass --no-project when creating the venv with activate-environment."
|
|
default: "false"
|
|
working-directory:
|
|
description: "The directory to execute all commands in and look for files such as pyproject.toml"
|
|
default: ${{ github.workspace }}
|
|
checksum:
|
|
description: "The checksum of the uv version to install"
|
|
required: false
|
|
github-token:
|
|
description:
|
|
"Used when downloading uv from GitHub releases."
|
|
required: false
|
|
default: ${{ github.token }}
|
|
enable-cache:
|
|
description: "Enable uploading of the uv cache"
|
|
default: "auto"
|
|
cache-dependency-glob:
|
|
description:
|
|
"Glob pattern to match files relative to the working directory to control
|
|
the cache."
|
|
default: |
|
|
**/*requirements*.txt
|
|
**/*requirements*.in
|
|
**/*constraints*.txt
|
|
**/*constraints*.in
|
|
**/pyproject.toml
|
|
**/uv.lock
|
|
**/*.py.lock
|
|
restore-cache:
|
|
description: "Whether to restore the cache if found."
|
|
default: "true"
|
|
save-cache:
|
|
description: "Whether to save the cache after the run."
|
|
default: "true"
|
|
cache-suffix:
|
|
description: "Suffix for the cache key"
|
|
required: false
|
|
cache-local-path:
|
|
description: "Local path to store the cache."
|
|
default: ""
|
|
prune-cache:
|
|
description: "Prune cache before saving."
|
|
default: "true"
|
|
cache-python:
|
|
description: "Upload managed Python installations to the Github Actions cache."
|
|
default: "false"
|
|
ignore-nothing-to-cache:
|
|
description: "Ignore when nothing is found to cache."
|
|
default: "false"
|
|
ignore-empty-workdir:
|
|
description: "Ignore when the working directory is empty."
|
|
default: "false"
|
|
tool-dir:
|
|
description: "Custom path to set UV_TOOL_DIR to."
|
|
required: false
|
|
tool-bin-dir:
|
|
description: "Custom path to set UV_TOOL_BIN_DIR to."
|
|
required: false
|
|
manifest-file:
|
|
description: "URL to a custom manifest file in the astral-sh/versions format."
|
|
required: false
|
|
download-from-astral-mirror:
|
|
description: "Download uv from the Astral mirror instead of directly from GitHub Releases."
|
|
default: "true"
|
|
add-problem-matchers:
|
|
description: "Add problem matchers."
|
|
default: "true"
|
|
quiet:
|
|
description: "Suppress info-level log output. Only warnings and errors are shown."
|
|
default: "false"
|
|
resolution-strategy:
|
|
description: "Resolution strategy to use when resolving version ranges. 'highest' uses the latest compatible version, 'lowest' uses the oldest compatible version."
|
|
default: "highest"
|
|
outputs:
|
|
uv-version:
|
|
description: "The installed uv version. Useful when using latest."
|
|
uv-path:
|
|
description: "The path to the installed uv binary."
|
|
uvx-path:
|
|
description: "The path to the installed uvx binary."
|
|
cache-hit:
|
|
description: "A boolean value to indicate a cache entry was found"
|
|
cache-key:
|
|
description: "The cache key used for storing/restoring the cache"
|
|
venv:
|
|
description: "Path to the activated venv if activate-environment is true"
|
|
python-version:
|
|
description: "The Python version that was set."
|
|
python-cache-hit:
|
|
description: "A boolean value to indicate the Python cache entry was found"
|
|
runs:
|
|
using: "node24"
|
|
main: "dist/setup/index.cjs"
|
|
post: "dist/save-cache/index.cjs"
|
|
post-if: success()
|
|
branding:
|
|
icon: "package"
|
|
color: "black"
|