You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Feb 15, 2026. It is now read-only.
Copy file name to clipboardExpand all lines: src/assets/pixi/integration/ci/github_actions.md
+52-20Lines changed: 52 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ We created [prefix-dev/setup-pixi](https://github.com/prefix-dev/setup-pixi) to
8
8
## Usage
9
9
10
10
```yaml
11
-
- uses: prefix-dev/setup-pixi@v0.9.2
11
+
- uses: prefix-dev/setup-pixi@v0.9.4
12
12
with:
13
13
pixi-version: v0.63.2
14
14
cache: true
@@ -19,7 +19,7 @@ We created [prefix-dev/setup-pixi](https://github.com/prefix-dev/setup-pixi) to
19
19
20
20
!!!warning "Pin your action versions"
21
21
Since pixi is not yet stable, the API of this action may change between minor versions.
22
-
Please pin the versions of this action to a specific version (i.e., `prefix-dev/setup-pixi@v0.9.2`) to avoid breaking changes.
22
+
Please pin the versions of this action to a specific version (i.e., `prefix-dev/setup-pixi@v0.9.4`) to avoid breaking changes.
23
23
You can automatically update the version of this action by using [Dependabot](https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot).
24
24
25
25
Put the following in your `.github/dependabot.yml` file to enable Dependabot for your GitHub Actions:
@@ -35,6 +35,8 @@ We created [prefix-dev/setup-pixi](https://github.com/prefix-dev/setup-pixi) to
35
35
dependencies:
36
36
patterns:
37
37
- "*"
38
+
cooldown:
39
+
default-days: 7
38
40
```
39
41
40
42
1. or `daily`, `weekly`
@@ -64,7 +66,7 @@ As there is no lockfile for global environments, the cache will expire at the en
64
66
This can be done by setting the `cache-write` argument.
The following example will install both the `py311` and the `py312` environment on the runner.
120
122
121
123
```yaml
122
-
- uses: prefix-dev/setup-pixi@v0.9.2
124
+
- uses: prefix-dev/setup-pixi@v0.9.4
123
125
with:
124
126
environments: >- # (1)!
125
127
py311
@@ -147,7 +149,7 @@ For instance, the `keyring`, or `gcloud` executables. The following example show
147
149
By default, global environments are not cached. You can enable caching by setting the `global-cache` input to `true`.
148
150
149
151
```yaml
150
-
- uses: prefix-dev/setup-pixi@v0.9.2
152
+
- uses: prefix-dev/setup-pixi@v0.9.4
151
153
with:
152
154
global-environments: |
153
155
google-cloud-sdk
@@ -180,7 +182,7 @@ Specify the token using the `auth-token` input argument.
180
182
This form of authentication (bearer token in the request headers) is mainly used at [prefix.dev](https://prefix.dev).
181
183
182
184
```yaml
183
-
- uses: prefix-dev/setup-pixi@v0.9.2
185
+
- uses: prefix-dev/setup-pixi@v0.9.4
184
186
with:
185
187
auth-host: prefix.dev
186
188
auth-token: ${{ secrets.PREFIX_DEV_TOKEN }}
@@ -192,7 +194,7 @@ Specify the username and password using the `auth-username` and `auth-password`
192
194
This form of authentication (HTTP Basic Auth) is used in some enterprise environments with [artifactory](https://jfrog.com/artifactory) for example.
193
195
194
196
```yaml
195
-
- uses: prefix-dev/setup-pixi@v0.9.2
197
+
- uses: prefix-dev/setup-pixi@v0.9.4
196
198
with:
197
199
auth-host: custom-artifactory.com
198
200
auth-username: ${{ secrets.PIXI_USERNAME }}
@@ -205,7 +207,7 @@ Specify the conda-token using the `conda-token` input argument.
205
207
This form of authentication (token is encoded in URL: `https://my-quetz-instance.com/t/<token>/get/custom-channel`) is used at [anaconda.org](https://anaconda.org) or with [quetz instances](https://github.com/mamba-org/quetz).
206
208
207
209
```yaml
208
-
- uses: prefix-dev/setup-pixi@v0.9.2
210
+
- uses: prefix-dev/setup-pixi@v0.9.4
209
211
with:
210
212
auth-host: anaconda.org # (1)!
211
213
auth-conda-token: ${{ secrets.CONDA_TOKEN }}
@@ -219,7 +221,7 @@ Specify the S3 key pair using the `auth-access-key-id` and `auth-secret-access-k
219
221
You can also specify the session token using the `auth-session-token` input argument.
@@ -236,7 +238,7 @@ See the [S3 section](../../deployment/s3.md) for more information about S3 authe
236
238
You can specify whether to use keyring to look up credentials for PyPI.
237
239
238
240
```yml
239
-
- uses: prefix-dev/setup-pixi@v0.9.2
241
+
- uses: prefix-dev/setup-pixi@v0.9.4
240
242
with:
241
243
pypi-keyring-provider: subprocess # one of 'subprocess', 'disabled'
242
244
```
@@ -312,15 +314,15 @@ To this end, `setup-pixi` adds all environment variables set when executing `pix
312
314
As a result, all installed binaries can be accessed without having to call `pixi run`.
313
315
314
316
```yaml
315
-
- uses: prefix-dev/setup-pixi@v0.9.2
317
+
- uses: prefix-dev/setup-pixi@v0.9.4
316
318
with:
317
319
activate-environment: true
318
320
```
319
321
320
322
If you are installing multiple environments, you will need to specify the name of the environment that you want to be activated.
321
323
322
324
```yaml
323
-
- uses: prefix-dev/setup-pixi@v0.9.2
325
+
- uses: prefix-dev/setup-pixi@v0.9.4
324
326
with:
325
327
environments: >-
326
328
py311
@@ -337,7 +339,7 @@ You can specify whether `setup-pixi` should run `pixi install --frozen` or `pixi
337
339
See the [official documentation](../../reference/cli/pixi/install.md#update-options) for more information about the `--frozen` and `--locked` flags.
338
340
339
341
```yaml
340
-
- uses: prefix-dev/setup-pixi@v0.9.2
342
+
- uses: prefix-dev/setup-pixi@v0.9.4
341
343
with:
342
344
locked: true
343
345
# or
@@ -367,7 +369,7 @@ The second type is the debug logging of the pixi executable.
367
369
This can be specified by setting the `log-level` input.
368
370
369
371
```yaml
370
-
- uses: prefix-dev/setup-pixi@v0.9.2
372
+
- uses: prefix-dev/setup-pixi@v0.9.4
371
373
with:
372
374
log-level: vvv # (1)!
373
375
```
@@ -394,7 +396,7 @@ If nothing is specified, `post-cleanup` will default to `true`.
394
396
On self-hosted runners, you also might want to alter the default pixi install location to a temporary location. You can use `pixi-bin-path: ${{ runner.temp }}/bin/pixi` to do this.
395
397
396
398
```yaml
397
-
- uses: prefix-dev/setup-pixi@v0.9.2
399
+
- uses: prefix-dev/setup-pixi@v0.9.4
398
400
with:
399
401
post-cleanup: true
400
402
pixi-bin-path: ${{ runner.temp }}/bin/pixi # (1)!
@@ -410,17 +412,47 @@ You can also use a preinstalled local version of pixi on the runner by not setti
410
412
This can be overwritten by setting the `manifest-path` input argument.
411
413
412
414
```yaml
413
-
- uses: prefix-dev/setup-pixi@v0.9.2
415
+
- uses: prefix-dev/setup-pixi@v0.9.4
414
416
with:
415
417
manifest-path: pyproject.toml
416
418
```
417
419
420
+
### Working directory for monorepos
421
+
422
+
If you're working with a monorepo where your pixi project is in a subdirectory, you can use the `working-directory` input to specify where pixi should look for manifest files (`pixi.toml` or `pyproject.toml`).
423
+
424
+
```yml
425
+
- uses: prefix-dev/setup-pixi@v0.9.4
426
+
with:
427
+
working-directory: ./packages/my-project
428
+
```
429
+
430
+
This will make pixi look for `pixi.toml` or `pyproject.toml` in the `./packages/my-project` directory instead of the repository root. All pixi commands will be executed from this working directory.
431
+
432
+
!!!note "Also in other steps"
433
+
The `working-directory` input only affects commands run by `setup-pixi` itself.
434
+
For subsequent `run:` steps, you need to set the working directory separately:
435
+
436
+
```yml
437
+
- run: pixi run test
438
+
working-directory: ./packages/my-project
439
+
```
440
+
441
+
You can combine `working-directory` with `manifest-path` if needed:
442
+
443
+
```yml
444
+
- uses: prefix-dev/setup-pixi@v0.9.4
445
+
with:
446
+
working-directory: ./packages/my-project
447
+
manifest-path: custom-pixi.toml
448
+
```
449
+
418
450
### Only install pixi
419
451
420
452
If you only want to install pixi and not install the current workspace, you can use the `run-install` option.
421
453
422
454
```yml
423
-
- uses: prefix-dev/setup-pixi@v0.9.2
455
+
- uses: prefix-dev/setup-pixi@v0.9.4
424
456
with:
425
457
run-install: false
426
458
```
@@ -431,7 +463,7 @@ You can also download pixi from a custom URL by setting the `pixi-url` input arg
431
463
Optionally, you can combine this with the `pixi-url-headers` input argument to supply additional headers for the download request, such as a bearer token.
Copy file name to clipboardExpand all lines: src/assets/pixi/misc/Community.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -66,3 +66,4 @@ Masked versions of Python array API standard compatible arrays.
66
66
-[pyfixest](https://github.com/py-econometrics/pyfixest): Fast High-Dimensional Fixed Effects Regression in Python following fixest-syntax.
67
67
-[geovista](https://github.com/bjlittle/geovista): Cartographic rendering and mesh analytics powered by [PyVista](https://github.com/pyvista/pyvista) 🌍
68
68
-[SciPy](https://github.com/scipy/scipy): Fundamental algorithms for scientific computing in Python.
69
+
-[Snakedown](https://github.com/savente93/snakedown) A fast and intuitive python API reference generator so you can host your docs with your favourite static site generator.
0 commit comments