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

Simplify GHA `UV_SYSTEM_PYTHON` examples (#5659)

This commit is contained in:
Zanie Blue 2024-07-31 11:49:40 -04:00 committed by GitHub
parent 22d152192d
commit 8d14a4cb4f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -143,13 +143,9 @@ If using the `uv pip` interface instead of the uv project interface, uv requires
environment by default. To allow installing packages into the system environment, use the `--system` environment by default. To allow installing packages into the system environment, use the `--system`
flag on all `uv` invocations or set the `UV_SYSTEM_PYTHON` variable. flag on all `uv` invocations or set the `UV_SYSTEM_PYTHON` variable.
### Setting `UV_SYSTEM_PYTHON` The `UV_SYSTEM_PYTHON` variable can be defined in at different scopes.
`UV_SYSTEM_PYTHON` variable can be defined in various scopes: Opt-in for the entire workflow by defining it at the top level:
i. Workflow-wide Environment Variables
Set the variable for the entire workflow by defining it at the top level:
```yaml title="example.yml" ```yaml title="example.yml"
env: env:
@ -158,9 +154,7 @@ env:
jobs: ... jobs: ...
``` ```
ii. Job-specific Environment Variables Or, opt-in for a specific job in the workflow:
Set the variable for a specific job within the workflow:
```yaml title="example.yml" ```yaml title="example.yml"
jobs: jobs:
@ -170,9 +164,7 @@ jobs:
... ...
``` ```
iii. Step-specific Environment Variables Or, opt-in for a specific step in a job:
Set the variable for a specific step:
```yaml title="example.yml" ```yaml title="example.yml"
steps: steps:
@ -182,16 +174,4 @@ steps:
UV_SYSTEM_PYTHON: 1 UV_SYSTEM_PYTHON: 1
``` ```
Now, `uv pip` can modify the system environment without creating and activating a virtual To opt-out again, the `--no-system` flag can be used in any uv invocation.
environment.
```yaml title="example.yml"
steps:
# ... setup up Python and uv ...
- name: Install requirements
run: uv pip install -r requirements.txt
- name: Run tests
run: pytest tests
```