Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
package

GitHub Action

Setup uv

v2

Setup uv

package

Setup uv

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

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Setup uv

              
  uses: yezz123/setup-uv@v2
Learn more about this action in yezz123/setup-uv

Choose a version

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@v1
  - 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@v1
    with:
      uv-version: "0.1.2"
  - run: uv --version

Allow to install prerelease versions of UV

steps:
  - uses: actions/checkout@v3
  - uses: actions/setup-python@v4
    with:
      python-version: "3.11"
  - uses: yezz123/setup-uv@v1
    with:
      uv-preview: true
  - 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@v1
    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.