Skip to content

Commit ef90b2f

Browse files
committed
document the file format
1 parent 8eff080 commit ef90b2f

File tree

1 file changed

+62
-0
lines changed

1 file changed

+62
-0
lines changed

python/uv/private/uv.bzl

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -356,6 +356,68 @@ def _get_tool_urls_from_dist_manifest(module_ctx, *, base_url, manifest_filename
356356
357357
This relies on the tools using the cargo packaging to infer the actual
358358
sha256 values for each binary.
359+
360+
Example manifest url: https://github.com/astral-sh/uv/releases/download/0.6.5/dist-manifest.json
361+
362+
The example format is as bellow
363+
364+
dist_version "0.28.0"
365+
announcement_tag "0.6.5"
366+
announcement_tag_is_implicit false
367+
announcement_is_prerelease false
368+
announcement_title "0.6.5"
369+
announcement_changelog "text"
370+
announcement_github_body "MD text"
371+
releases [
372+
{
373+
app_name "uv"
374+
app_version "0.6.5"
375+
env
376+
install_dir_env_var "UV_INSTALL_DIR"
377+
unmanaged_dir_env_var "UV_UNMANAGED_INSTALL"
378+
disable_update_env_var "UV_DISABLE_UPDATE"
379+
no_modify_path_env_var "UV_NO_MODIFY_PATH"
380+
github_base_url_env_var "UV_INSTALLER_GITHUB_BASE_URL"
381+
ghe_base_url_env_var "UV_INSTALLER_GHE_BASE_URL"
382+
display_name "uv"
383+
display true
384+
artifacts [
385+
"source.tar.gz"
386+
"source.tar.gz.sha256"
387+
"uv-installer.sh"
388+
"uv-installer.ps1"
389+
"sha256.sum"
390+
"uv-aarch64-apple-darwin.tar.gz"
391+
"uv-aarch64-apple-darwin.tar.gz.sha256"
392+
"...
393+
]
394+
artifacts
395+
uv-aarch64-apple-darwin.tar.gz
396+
name "uv-aarch64-apple-darwin.tar.gz"
397+
kind "executable-zip"
398+
target_triples [
399+
"aarch64-apple-darwin"
400+
assets [
401+
{
402+
id "uv-aarch64-apple-darwin-exe-uv"
403+
name "uv"
404+
path "uv"
405+
kind "executable"
406+
},
407+
{
408+
id "uv-aarch64-apple-darwin-exe-uvx"
409+
name "uvx"
410+
path "uvx"
411+
kind "executable"
412+
}
413+
]
414+
checksum "uv-aarch64-apple-darwin.tar.gz.sha256"
415+
uv-aarch64-apple-darwin.tar.gz.sha256
416+
name "uv-aarch64-apple-darwin.tar.gz.sha256"
417+
kind "checksum"
418+
target_triples [
419+
"aarch64-apple-darwin"
420+
]
359421
"""
360422
dist_manifest = module_ctx.path(manifest_filename)
361423
result = module_ctx.download(

0 commit comments

Comments
 (0)