Python
/
uv
mirror of https://github.com/astral-sh/uv
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add `python-version-file` to GitHub integration documentation (#6086)

This commit is contained in:
Zanie Blue 2024-08-14 10:50:37 -05:00 committed by GitHub
parent d6c858b0d3
commit d971d6b1da
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 18 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/guides/integration/github.md
View File

@ -109,15 +109,30 @@ steps:
run: uv python install ${{ matrix.python-version }} run: uv python install ${{ matrix.python-version }}
``` ```
Alternatively, the official GitHub `setup-python` action can be used. This is generally faster, but Alternatively, the official GitHub `setup-python` action can be used. This can be faster, because
will not respect the project's pinned Python version. GitHub caches the Python versions alongside the runner.
Set the
[`python-version-file`](https://github.com/actions/setup-python/blob/main/docs/advanced-usage.md#using-the-python-version-file-input)
option to use the pinned version for the project:
```yaml title="example.yml" ```yaml title="example.yml"
steps: steps:
- name: "Set up Python" - name: "Set up Python"
uses: actions/setup-python@v5 uses: actions/setup-python@v5
with: with:
python-version: 3.12 python-version-file: ".python-version"
```
Or, specify the `pyproject.toml` file to ignore the pin and use the latest version compatible with
the project's `requires-python` constraint:
```yaml title="example.yml"
steps:
- name: "Set up Python"
uses: actions/setup-python@v5
with:
python-version-file: "pyproject.toml"
``` ```
## Syncing and running ## Syncing and running