Skip to content

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

License

Notifications You must be signed in to change notification settings

yezz123/setup-uv

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

setup-uv

Build Status

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.