yezz123 / setup-uv Goto Github PK

View Code? Open in Web Editor NEW

27.0 2.0 1.0 870 KB

Set up your GitHub Actions workflow with a specific version of uv

Home Page: https://github.com/astral-sh/uv

License: MIT License

TypeScript 100.00%

astral ruff uv dependencies pip

setup-uv's Introduction

setup-uv

This action sets up a uv for use in actions by installing a version of UV and adding to PATH. The action will fail if no matching versions are found.

This action supports versions of:

Python >=3.8
uv >=0.1.2

Usage

Install latest available version of UV

steps:
  - uses: actions/checkout@v3
  - uses: actions/setup-python@v4
    with:
      python-version: "3.11"
  - uses: yezz123/setup-uv@v4
  - run: uv --version

Exact version of UV to install, using SemVer's version syntax

steps:
  - uses: actions/checkout@v3
  - uses: actions/setup-python@v4
    with:
      python-version: "3.11"
  - uses: yezz123/setup-uv@v4
    with:
      uv-version: "0.1.12"
  - run: uv --version

Create and activate a virtual environment using uv

steps:
  - uses: actions/checkout@v3
  - uses: actions/setup-python@v4
    with:
      python-version: "3.11"
  - uses: yezz123/setup-uv@v4
    with:
      uv-venv: "your_venv_name"
  - run: uv pip install black # this command will run in the uv environment

Contributing

Create issues

You can create a new issue in the GitHub repository, for example to:

Ask a question or ask about a problem.
Suggest a new feature.

Note: if you create an issue, then I'm going to ask you to also help others. 😉

Create a Pull Request

You can contribute to the source code with Pull Requests, for example:

To fix a typo you found on the documentation.
To propose new documentation sections.
To fix an existing issue/bug.
To add a new feature.

License 📄

This project is licensed under the terms of the MIT License.

setup-uv's People

Contributors

Stargazers

Watchers

Forkers

mz0in

setup-uv's Issues

🐛 fix uv version implementation

currently, if we try to install a specific version of uv we implement it like this:

steps:
  - uses: actions/checkout@v3
  - uses: actions/setup-python@v4
    with:
      python-version: "3.11"
  - uses: yezz123/setup-uv@v1
    with:
      uv-version: "0.1.5"
  - run: uv --version

but as I noticed it installed the default version which is the latest one, i should investigate this here:

https://github.com/yezz123/setup-uv/blob/main/src/inputs.ts#L27-L44

Check here: https://github.com/yezz123/authx/actions/runs/7990744469/job/21820221268?pr=546

Support for auto-updating the uv version

Hey 👋🏼

Thanks for your work on this project! Integrating it into some of our repositories over at https://github.com/cda-tum was pretty smooth sailing and works nicely. Consider this issue more a request for comment or a suggestion and not as an issue per se.

Right now, the action will (rightfully, imo) emit a warning when not specifying an explicit version of uv to use.
However, not specifying a version generally lowers the maintenance overhead as one keeps automatically getting new versions.
If I would specify a version explicitly (maybe even using SemVer to permit patch version updates), I would have to manually check for new versions continuously and update them in all projects that use this action.
Given that the version is specified as an option to the action, this is cannot be simply updated by dependabot and I am not really aware of any other solutions for automating that particular setting. (that might just be my ignorance, though 😅)

Over at nox (and probably many others, such as cibulidwheel) this is solved by versioning the action with the same version as the tool the action provides. For convenience, some of those repositories provide additional (moving) tags for their actions that would, e.g., allow for action versions such as @2.5, which would correspond to ~2.5.0 in SemVer or @2, which would correspond to ~2.0.
This kind of versioning policy of the action allows for using dependabot to get automatic updates through CI, while still giving the user the option to decide which granularity of SemVer they want to go for.

Would you consider something like that? Feel free to close this issue if you feel that this is totally out of scope for this action here 😌
(Technically, one could directly bring this up to the folks at @astral-sh and ask if they would be willing to set something like that up.)

automate the setup of the virtual environment

steps:
  - uses: actions/checkout@v3
  - uses: actions/setup-python@v4
    with:
      python-version: "3.11"
  - uses: yezz123/setup-uv@v1
    with:
      uv-version: "0.1.2"
      uv-venv: ".venv"
  - run: uv --version

something like this to automate the setup of virtual environment

Support for caching

Would be great if caching would be supported out of the box. setup-cached-uv or setup-python-uv-action could be some inspiration.