Add section to README explaining if packages are installed by setup-uv (#398)

Fixes #397
This commit is contained in:
Nick Sweeting 2025-05-03 10:41:06 -07:00 committed by GitHub
parent ced7c1dde4
commit 023b8ec2bc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -488,6 +488,11 @@ Some workflows need uv but do not need to access the repository content.
But **if** you need to access the repository content, you have run `actions/checkout` before running `setup-uv`.
Running `actions/checkout` after `setup-uv` **is not supported**.
### Does `setup-uv` also install my project or its dependencies automatically?
No, `setup-uv` alone wont install any libraries from your `pyproject.toml` or `requirements.txt`, it only sets up `uv`.
You should run `uv sync` or `uv pip install .` separately, or use `uv run ...` to ensure necessary dependencies are installed.
## Acknowledgements
`setup-uv` was initially written and published by [Kevin Stillhammer](https://github.com/eifinger)