actions/setup-uv
2
0
Fork 0
mirror of https://github.com/astral-sh/setup-uv.git synced 2026-03-13 01:26:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Use astral-sh/versions as primary version provider (#802)

Browse Source 
Closes: #777
Closes: #325
This commit is contained in:
Kevin Stillhammer
2026-03-12 22:03:21 +01:00
committed by GitHub
parent 0f6ec07aaf
commit e06108dd0a
28 changed files with 2022 additions and 41294 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
docs/customization.md
View File

@@ -18,12 +18,29 @@ are automatically verified by this action. The sha256 hashes can be found on the
## Manifest file
The `manifest-file` input allows you to specify a JSON manifest that lists available uv versions,
architectures, and their download URLs. By default, this action uses the manifest file contained
in this repository, which is automatically updated with each release of uv.
By default, setup-uv reads version metadata from
[`astral-sh/versions`](https://github.com/astral-sh/versions) (NDJSON format).
The manifest file contains an array of objects, each describing a version,
architecture, platform, and the corresponding download URL. For example:
The `manifest-file` input lets you override that source with your own URL, for example to test
custom uv builds or alternate download locations.
### Format
The manifest file must be in NDJSON format, where each line is a JSON object representing a version and its artifacts. 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.
### Legacy format: JSON array (deprecated)
The previous JSON array format is still supported for compatibility, but deprecated and will be
removed in a future major release.
```json
[
@@ -33,26 +50,20 @@ architecture, platform, and the corresponding download URL. For example:
"arch": "aarch64",
"platform": "apple-darwin",
"downloadUrl": "https://github.com/astral-sh/uv/releases/download/0.7.13/uv-aarch64-apple-darwin.tar.gz"
},
...
}
]
```
You can supply a custom manifest file URL to define additional versions,
architectures, or different download URLs.
This is useful if you maintain your own uv builds or want to override the default sources.
```yaml
- name: Use a custom manifest file
uses: astral-sh/setup-uv@v7
with:
manifest-file: "https://example.com/my-custom-manifest.json"
manifest-file: "https://example.com/my-custom-manifest.ndjson"
```
> [!NOTE]
> When you use a custom manifest file and do not set the `version` input, its default value is `latest`.
> This means the action will install the latest version available in the custom manifest file.
> This is different from the default behavior of installing the latest version from the official uv releases.
> 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