Skip to content

Commit 400c29d

Browse files
authored
Add FAQ section (#305)
1 parent 3ba482b commit 400c29d

1 file changed

Lines changed: 21 additions & 4 deletions

File tree

README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -131,17 +131,34 @@ To avoid hitting the error `API rate limit exceeded` you can supply a GitHub tok
131131
github-token: ${{ secrets.GITHUB_TOKEN }}
132132
```
133133

134-
## Limitations
135-
136-
1. Currently only Linux and macOS is supported see [issue #10](https://github.com/eifinger/setup-rye/issues/10)
137-
138134
## How it works
139135

140136
This action downloads rye from the releases of the [rye repo](https://github.com/astral-sh/rye) and uses the [GitHub Actions Toolkit](https://github.com/actions/toolkit) to cache it as a tool to speed up consecutive runs especially on self-hosted runners.
141137

142138
The installed version of rye is then added to the runner path so other steps can just use it by calling `rye`.
143139
To prevent interfering the other rye processes on the same runner `RYE_HOME` gets set to the repository roots parent and is cleaned up after a workflow run.
144140

141+
## FAQ
142+
143+
### Do I still need actions/setup-python when using this action?
144+
145+
No! This action was modelled as a drop-in replacement for `actions/setup-python` when using rye.
146+
147+
A simple example workflow could look like this:
148+
149+
```yaml
150+
- name: Checkout the repository
151+
uses: actions/checkout@v2
152+
- name: Install the latest version of rye
153+
uses: eifinger/setup-rye@v4
154+
with:
155+
enable-cache: true
156+
- name: Sync dependencies
157+
run: rye sync
158+
- name: Lint
159+
run: rye lint
160+
```
161+
145162
---
146163

147164
[<img src="https://raw.githubusercontent.com/eifinger/setup-rye/main/docs/images/bmc-button.svg" width=150 height=40 style="margin: 5px"/>](https://www.buymeacoffee.com/eifinger)

0 commit comments

Comments
 (0)