Skip to content

Commit d8db0a8

Browse files
authored
Change some formulations in README.md (#164)
1 parent ed171c2 commit d8db0a8

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ For an example workflow, see
4343
4444
> [!TIP]
4545
>
46-
> Using `latest` requires that uv download the executable on every run, which incurs a cost
46+
> Using `latest` requires to download the uv executable on every run, which incurs a cost
4747
> (especially on self-hosted runners). As a best practice, consider pinning the version to a
4848
> specific release.
4949

@@ -58,7 +58,7 @@ For an example workflow, see
5858

5959
### Install a version by supplying a semver range
6060

61-
You can also specify a [semver range](https://github.com/npm/node-semver?tab=readme-ov-file#ranges)
61+
You can specify a [semver range](https://github.com/npm/node-semver?tab=readme-ov-file#ranges)
6262
to install the latest version that satisfies the range.
6363

6464
```yaml
@@ -77,7 +77,7 @@ to install the latest version that satisfies the range.
7777

7878
### Validate checksum
7979

80-
You can also specify a checksum to validate the downloaded file. Checksums up to the default version
80+
You can specify a checksum to validate the downloaded executable. Checksums up to the default version
8181
are automatically verified by this action. The sha256 hashes can be found on the
8282
[releases page](https://github.com/astral-sh/uv/releases) of the uv repo.
8383

@@ -91,8 +91,8 @@ are automatically verified by this action. The sha256 hashes can be found on the
9191

9292
### Enable caching
9393

94-
If you enable caching, the [uv cache](https://docs.astral.sh/uv/concepts/cache/) will be cached to
95-
the GitHub Actions Cache. This can speed up runs that reuse the cache by several minutes.
94+
If you enable caching, the [uv cache](https://docs.astral.sh/uv/concepts/cache/) will be uploaded to
95+
the GitHub Actions cache. This can speed up runs that reuse the cache by several minutes.
9696

9797
> [!TIP]
9898
>
@@ -121,9 +121,9 @@ use it in subsequent steps. For example, to use the cache in the above case:
121121

122122
#### Cache dependency glob
123123

124-
If you want to control when the cache is invalidated, specify a glob pattern with the
125-
`cache-dependency-glob` input. The cache will be invalidated if any file matching the glob pattern
126-
changes. If you use relative paths, the glob matches files relative to the repository root.
124+
If you want to control when the GitHub Actions cache is invalidated, specify a glob pattern with the
125+
`cache-dependency-glob` input. The GitHub Actions cache will be invalidated if any file matching the glob pattern
126+
changes. If you use relative paths, they are relative to the repository root.
127127

128128
> [!NOTE]
129129
>
@@ -183,8 +183,8 @@ By default, the uv cache is pruned after every run, removing pre-built wheels, b
183183
wheels that were built from source. On GitHub-hosted runners, it's typically faster to omit those
184184
pre-built wheels from the cache (and instead re-download them from the registry on each run).
185185
However, on self-hosted or local runners, preserving the cache may be more efficient. See
186-
the[documentation](https://docs.astral.sh/uv/concepts/cache/#caching-in-continuous-integration) for
187-
more.
186+
the [documentation](https://docs.astral.sh/uv/concepts/cache/#caching-in-continuous-integration) for
187+
more information.
188188

189189
If you want to persist the entire cache across runs, disable cache pruning with the `prune-cache`
190190
input.
@@ -199,8 +199,8 @@ input.
199199

200200
### Ignore nothing to cache
201201

202-
By default, the action will fail if there is nothing to cache. If you want to ignore this, set the
203-
`ignore-nothing-to-cache` input to `true`.
202+
By default, the action will fail if there is nothing to cache (the uv cache directory does not exist).
203+
If you want to ignore this, set the `ignore-nothing-to-cache` input to `true`.
204204

205205
```yaml
206206
- name: Ignore nothing to cache

0 commit comments

Comments
 (0)