Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Simplify GHA UV_SYSTEM_PYTHON examples #5659

Merged
merged 1 commit into from
Jul 31, 2024
Merged

Simplify GHA UV_SYSTEM_PYTHON examples #5659

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 5 additions & 25 deletions docs/guides/integration/github.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
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:

i. Workflow-wide Environment Variables

Set the variable for the entire workflow by defining it at the top level:
Opt-in for the entire workflow by defining it at the top level:

```yaml title="example.yml"
env:
Expand All @@ -158,9 +154,7 @@ env:
jobs: ...
```

ii. Job-specific Environment Variables

Set the variable for a specific job within the workflow:
Or, opt-in for a specific job in the workflow:

```yaml title="example.yml"
jobs:
Expand All @@ -170,9 +164,7 @@ jobs:
...
```

iii. Step-specific Environment Variables

Set the variable for a specific step:
Or, opt-in for a specific step in a job:

```yaml title="example.yml"
steps:
Expand All @@ -182,16 +174,4 @@ steps:
UV_SYSTEM_PYTHON: 1
```

Now, `uv pip` can modify the system environment without creating and activating a virtual
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
```
To opt-out again, the `--no-system` flag can be used in any uv invocation.
Loading