Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make some minor edits to the README #46

Merged
merged 1 commit into from
Sep 5, 2024
Merged

Make some minor edits to the README #46

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 13 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,6 @@ Set up your GitHub Actions workflow with a specific version of [uv](https://docs

## Usage

Example workflow in a real world project can be found
[here](https://github.com/eifinger/hass-weenect/blob/main/.github/workflows/ci.yml)

### Install the latest version (default)

```yaml
Expand All @@ -35,9 +32,14 @@ Example workflow in a real world project can be found
version: "latest"
```

> [!TIP] Using `latest` requires that uv download the executable on every run, which incurs a cost
> (especially on self-hosted runners). As an alternative, consider pinning the version to a specific
> release.
For an example workflow, see
[here](https://github.com/charliermarsh/autobot/blob/e42c66659bf97b90ca9ff305a19cc99952d0d43f/.github/workflows/ci.yaml).

> [!TIP]
>
> Using `latest` requires that uv download the executable on every run, which incurs a cost
> (especially on self-hosted runners). As a best practice, consider pinning the version to a
> specific release.

### Install a specific version

Expand Down Expand Up @@ -125,7 +127,7 @@ changes. The glob matches files relative to the repository root.

### API rate limit

To avoid hitting the error `API rate limit exceeded`, supply a GitHub token with the `github-token`
To avoid hitting the `API rate limit exceeded` error, supply a GitHub token via the `github-token`
input.

```yaml
Expand All @@ -147,9 +149,11 @@ by name (`uv`).

## FAQ

### Do I still need actions/setup-python when using this action?
### Do I still need `actions/setup-python` alongside `setup-uv`?

No! This action was modelled as a drop-in replacement for `actions/setup-python` when using uv.
No. This action is modelled as a drop-in replacement for `actions/setup-python` when using uv. With
`setup-uv`, you can install a specific version of Python using `uv python install` rather than
relaying on `actions/setup-python`.

For example:

Expand Down