mirror of
https://github.com/astral-sh/setup-uv.git
synced 2026-11-05 01:35:32 +00:00
4c58170a94
Update `uses: astral-sh/setup-uv@...` references in documentation to `68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3`. Co-authored-by: eifinger <1481961+eifinger@users.noreply.github.com>
68 lines
2.8 KiB
Markdown
68 lines
2.8 KiB
Markdown
# Customization
|
|
|
|
This document covers advanced customization options including checksum validation, custom manifests, and problem matchers.
|
|
|
|
## Validate checksum
|
|
|
|
Downloaded executables are automatically verified using checksums bundled with this action or,
|
|
for newer, not yet bundled versions, the checksum from [`astral-sh/versions`](https://github.com/astral-sh/versions).
|
|
You can specify a checksum to override those values. The sha256 hashes can also be found on the
|
|
[releases page](https://github.com/astral-sh/uv/releases) of the uv repo.
|
|
|
|
```yaml
|
|
- name: Install a specific version and validate the checksum
|
|
uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
|
|
with:
|
|
version: "0.3.1"
|
|
checksum: "e11b01402ab645392c7ad6044db63d37e4fd1e745e015306993b07695ea5f9f8"
|
|
```
|
|
|
|
## Manifest file
|
|
|
|
By default, setup-uv reads version metadata from
|
|
the [Astral mirror](https://releases.astral.sh/github/versions/main/v1/uv.ndjson).
|
|
If the mirror request fails, it falls back to [`astral-sh/versions`](https://github.com/astral-sh/versions).
|
|
|
|
The `manifest-file` input lets you override that source with your own URL, for example to test
|
|
custom uv builds or alternate download locations. Custom manifest URLs do not fall back to the
|
|
default sources.
|
|
|
|
### Format
|
|
|
|
The manifest file must use the same format as `astral-sh/versions`: one JSON object per line, where each object represents a version and its artifacts. The versions must be sorted in descending order. For example:
|
|
|
|
```json
|
|
{"version":"0.10.7","artifacts":[{"platform":"x86_64-unknown-linux-gnu","variant":"default","url":"https://example.com/uv-x86_64-unknown-linux-gnu.tar.gz","archive_format":"tar.gz","sha256":"..."}]}
|
|
{"version":"0.10.6","artifacts":[{"platform":"x86_64-unknown-linux-gnu","variant":"default","url":"https://example.com/uv-x86_64-unknown-linux-gnu.tar.gz","archive_format":"tar.gz","sha256":"..."}]}
|
|
```
|
|
|
|
setup-uv currently only supports `default` as the `variant`.
|
|
|
|
The `archive_format` field is currently ignored.
|
|
|
|
```yaml
|
|
- name: Use a custom manifest file
|
|
uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
|
|
with:
|
|
manifest-file: "https://example.com/my-custom-manifest.ndjson"
|
|
```
|
|
|
|
> [!NOTE]
|
|
> When you use a custom manifest file and do not set the `version` input, setup-uv installs the
|
|
> latest version from that custom manifest.
|
|
|
|
## Add problem matchers
|
|
|
|
This action automatically adds
|
|
[problem matchers](https://github.com/actions/toolkit/blob/main/docs/problem-matchers.md)
|
|
for python errors.
|
|
|
|
You can disable this by setting the `add-problem-matchers` input to `false`.
|
|
|
|
```yaml
|
|
- name: Install the latest version of uv without problem matchers
|
|
uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
|
|
with:
|
|
add-problem-matchers: false
|
|
```
|