actions/setup-uv
1
0
Fork 0
mirror of https://github.com/astral-sh/setup-uv.git synced 2025-01-19 08:18:18 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Change some formulations in README.md (#164)

Browse Source
This commit is contained in:
Kevin Stillhammer 2024-11-23 16:47:24 +01:00 committed by GitHub
parent ed171c292b
commit d8db0a86d3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -43,7 +43,7 @@ For an example workflow, see
> [!TIP] > [!TIP]
> >
> Using `latest` requires that uv download the executable on every run, which incurs a cost > Using `latest` requires to download the uv executable on every run, which incurs a cost
> (especially on self-hosted runners). As a best practice, consider pinning the version to a > (especially on self-hosted runners). As a best practice, consider pinning the version to a
> specific release. > specific release.
@ -58,7 +58,7 @@ For an example workflow, see
### Install a version by supplying a semver range ### Install a version by supplying a semver range
You can also specify a [semver range](https://github.com/npm/node-semver?tab=readme-ov-file#ranges) You can specify a [semver range](https://github.com/npm/node-semver?tab=readme-ov-file#ranges)
to install the latest version that satisfies the range. to install the latest version that satisfies the range.
```yaml ```yaml
@ -77,7 +77,7 @@ to install the latest version that satisfies the range.
### Validate checksum ### Validate checksum
You can also specify a checksum to validate the downloaded file. Checksums up to the default version You can specify a checksum to validate the downloaded executable. Checksums up to the default version
are automatically verified by this action. The sha256 hashes can be found on the are automatically verified by this action. The sha256 hashes can be found on the
[releases page](https://github.com/astral-sh/uv/releases) of the uv repo. [releases page](https://github.com/astral-sh/uv/releases) of the uv repo.
@ -91,8 +91,8 @@ are automatically verified by this action. The sha256 hashes can be found on the
### Enable caching ### Enable caching
If you enable caching, the [uv cache](https://docs.astral.sh/uv/concepts/cache/) will be cached to If you enable caching, the [uv cache](https://docs.astral.sh/uv/concepts/cache/) will be uploaded to
the GitHub Actions Cache. This can speed up runs that reuse the cache by several minutes. the GitHub Actions cache. This can speed up runs that reuse the cache by several minutes.
> [!TIP] > [!TIP]
> >
@ -121,9 +121,9 @@ use it in subsequent steps. For example, to use the cache in the above case:
#### Cache dependency glob #### Cache dependency glob
If you want to control when the cache is invalidated, specify a glob pattern with the If you want to control when the GitHub Actions cache is invalidated, specify a glob pattern with the
`cache-dependency-glob` input. The cache will be invalidated if any file matching the glob pattern `cache-dependency-glob` input. The GitHub Actions cache will be invalidated if any file matching the glob pattern
changes. If you use relative paths, the glob matches files relative to the repository root. changes. If you use relative paths, they are relative to the repository root.
> [!NOTE] > [!NOTE]
> >
@ -183,8 +183,8 @@ By default, the uv cache is pruned after every run, removing pre-built wheels, b
wheels that were built from source. On GitHub-hosted runners, it's typically faster to omit those wheels that were built from source. On GitHub-hosted runners, it's typically faster to omit those
pre-built wheels from the cache (and instead re-download them from the registry on each run). pre-built wheels from the cache (and instead re-download them from the registry on each run).
However, on self-hosted or local runners, preserving the cache may be more efficient. See However, on self-hosted or local runners, preserving the cache may be more efficient. See
the[documentation](https://docs.astral.sh/uv/concepts/cache/#caching-in-continuous-integration) for the [documentation](https://docs.astral.sh/uv/concepts/cache/#caching-in-continuous-integration) for
more. more information.
If you want to persist the entire cache across runs, disable cache pruning with the `prune-cache` If you want to persist the entire cache across runs, disable cache pruning with the `prune-cache`
input. input.
@ -199,8 +199,8 @@ input.
### Ignore nothing to cache ### Ignore nothing to cache
By default, the action will fail if there is nothing to cache. If you want to ignore this, set the By default, the action will fail if there is nothing to cache (the uv cache directory does not exist).
`ignore-nothing-to-cache` input to `true`. If you want to ignore this, set the `ignore-nothing-to-cache` input to `true`.
```yaml ```yaml
- name: Ignore nothing to cache - name: Ignore nothing to cache