actions/setup-uv
2
0
Fork 0
mirror of https://github.com/astral-sh/setup-uv.git synced 2026-09-04 06:39:22 +00:00
Code Activity

Crunch docs, remove examples

Browse Source 
These identifiers should be considered opaque.

Signed-off-by: William Woodruff <william@yossarian.net>
This commit is contained in:
William Woodruff
2026-09-03 15:38:50 -04:00
parent ce013a24a4
commit 18b7c1ee5f
1 changed files with 5 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/environment-and-tools.md
+5 -18
View File
@@ -18,25 +18,12 @@ This allows directly using it in later steps:
By default, the venv is created at `.venv` inside the `working-directory`. By default, the venv is created at `.venv` inside the `working-directory`.
With `activate-environment: true`, the `python-runtime-id` output identifies the With `activate-environment: true`, the `python-runtime-id` output identifies the
venv's Python runtime using its implementation, full Python version (including venv's Python runtime. This is an opaque identifier that users of the action
prerelease numbers), and whether the interpreter was built for free threading. can use as a cache key if necessary; users should not assume anything about
For implementations other than CPython, it also includes the implementation's own the stability or structure of the identifier itself.
version, so upgrading PyPy changes the identifier even if its Python version stays
the same.
Example identifiers: For example, you can combine it with the platform and dependency information relevant to
your cache with `id: setup-uv` on the setup step:
| Runtime | `python-runtime-id` |
| --- | --- |
| CPython RC1 | `cpython-3.15.0rc1` |
| Free-threaded CPython RC1 | `cpython-3.15.0rc1-freethreaded` |
| Free-threaded CPython RC2 | `cpython-3.15.0rc2-freethreaded` |
| PyPy | `pypy-7.3.23-python-3.11.15` |
This is an opaque identifier in a setup-uv-defined format, not a Python version
specifier. Use the whole value as a cache-key component rather than parsing it.
Combine it with the platform and dependency information relevant to your cache,
for example (with `id: setup-uv` on the setup step):
```yaml ```yaml
key: build-${{ runner.os }}-${{ runner.arch }}-${{ steps.setup-uv.outputs.python-runtime-id }}-${{ hashFiles('uv.lock') }} key: build-${{ runner.os }}-${{ runner.arch }}-${{ steps.setup-uv.outputs.python-runtime-id }}-${{ hashFiles('uv.lock') }}