Skip to content
This repository was archived by the owner on Feb 15, 2026. It is now read-only.

Commit e3b4f0c

Browse files
KemingHegithub-actions[bot]
authored andcommitted
docs(src/assets/): update pixi official documentation
1 parent cbd85d1 commit e3b4f0c

4 files changed

Lines changed: 56 additions & 23 deletions

File tree

src/assets/pixi/_metadata.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"source_repo": "prefix-dev/pixi",
33
"docs_path": "docs",
4-
"updated_at": "2026-01-27T22:06:40Z",
5-
"commit_sha": "bb5e1f751a0a5a0e62daea6157deae61f8e7c844"
4+
"updated_at": "2026-02-03T22:10:33Z",
5+
"commit_sha": "2ea837eee94aeccab1c50b6d26bcc9496eae4180"
66
}

src/assets/pixi/integration/ci/github_actions.md

Lines changed: 52 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ We created [prefix-dev/setup-pixi](https://github.com/prefix-dev/setup-pixi) to
88
## Usage
99

1010
```yaml
11-
- uses: prefix-dev/setup-pixi@v0.9.2
11+
- uses: prefix-dev/setup-pixi@v0.9.4
1212
with:
1313
pixi-version: v0.63.2
1414
cache: true
@@ -19,7 +19,7 @@ We created [prefix-dev/setup-pixi](https://github.com/prefix-dev/setup-pixi) to
1919
2020
!!!warning "Pin your action versions"
2121
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.
2323
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).
2424

2525
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
3535
dependencies:
3636
patterns:
3737
- "*"
38+
cooldown:
39+
default-days: 7
3840
```
3941

4042
1. or `daily`, `weekly`
@@ -64,7 +66,7 @@ As there is no lockfile for global environments, the cache will expire at the en
6466
This can be done by setting the `cache-write` argument.
6567

6668
```yaml
67-
- uses: prefix-dev/setup-pixi@v0.9.2
69+
- uses: prefix-dev/setup-pixi@v0.9.4
6870
with:
6971
cache: true
7072
cache-write: ${{ github.event_name == 'push' && github.ref_name == 'main' }}
@@ -109,7 +111,7 @@ test:
109111
environment: [py311, py312]
110112
steps:
111113
- uses: actions/checkout@v4
112-
- uses: prefix-dev/setup-pixi@v0.9.2
114+
- uses: prefix-dev/setup-pixi@v0.9.4
113115
with:
114116
environments: ${{ matrix.environment }}
115117
```
@@ -119,7 +121,7 @@ test:
119121
The following example will install both the `py311` and the `py312` environment on the runner.
120122

121123
```yaml
122-
- uses: prefix-dev/setup-pixi@v0.9.2
124+
- uses: prefix-dev/setup-pixi@v0.9.4
123125
with:
124126
environments: >- # (1)!
125127
py311
@@ -147,7 +149,7 @@ For instance, the `keyring`, or `gcloud` executables. The following example show
147149
By default, global environments are not cached. You can enable caching by setting the `global-cache` input to `true`.
148150

149151
```yaml
150-
- uses: prefix-dev/setup-pixi@v0.9.2
152+
- uses: prefix-dev/setup-pixi@v0.9.4
151153
with:
152154
global-environments: |
153155
google-cloud-sdk
@@ -180,7 +182,7 @@ Specify the token using the `auth-token` input argument.
180182
This form of authentication (bearer token in the request headers) is mainly used at [prefix.dev](https://prefix.dev).
181183

182184
```yaml
183-
- uses: prefix-dev/setup-pixi@v0.9.2
185+
- uses: prefix-dev/setup-pixi@v0.9.4
184186
with:
185187
auth-host: prefix.dev
186188
auth-token: ${{ secrets.PREFIX_DEV_TOKEN }}
@@ -192,7 +194,7 @@ Specify the username and password using the `auth-username` and `auth-password`
192194
This form of authentication (HTTP Basic Auth) is used in some enterprise environments with [artifactory](https://jfrog.com/artifactory) for example.
193195

194196
```yaml
195-
- uses: prefix-dev/setup-pixi@v0.9.2
197+
- uses: prefix-dev/setup-pixi@v0.9.4
196198
with:
197199
auth-host: custom-artifactory.com
198200
auth-username: ${{ secrets.PIXI_USERNAME }}
@@ -205,7 +207,7 @@ Specify the conda-token using the `conda-token` input argument.
205207
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).
206208

207209
```yaml
208-
- uses: prefix-dev/setup-pixi@v0.9.2
210+
- uses: prefix-dev/setup-pixi@v0.9.4
209211
with:
210212
auth-host: anaconda.org # (1)!
211213
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
219221
You can also specify the session token using the `auth-session-token` input argument.
220222

221223
```yaml
222-
- uses: prefix-dev/setup-pixi@v0.9.2
224+
- uses: prefix-dev/setup-pixi@v0.9.4
223225
with:
224226
auth-host: s3://my-s3-bucket
225227
auth-s3-access-key-id: ${{ secrets.ACCESS_KEY_ID }}
@@ -236,7 +238,7 @@ See the [S3 section](../../deployment/s3.md) for more information about S3 authe
236238
You can specify whether to use keyring to look up credentials for PyPI.
237239

238240
```yml
239-
- uses: prefix-dev/setup-pixi@v0.9.2
241+
- uses: prefix-dev/setup-pixi@v0.9.4
240242
with:
241243
pypi-keyring-provider: subprocess # one of 'subprocess', 'disabled'
242244
```
@@ -312,15 +314,15 @@ To this end, `setup-pixi` adds all environment variables set when executing `pix
312314
As a result, all installed binaries can be accessed without having to call `pixi run`.
313315

314316
```yaml
315-
- uses: prefix-dev/setup-pixi@v0.9.2
317+
- uses: prefix-dev/setup-pixi@v0.9.4
316318
with:
317319
activate-environment: true
318320
```
319321

320322
If you are installing multiple environments, you will need to specify the name of the environment that you want to be activated.
321323

322324
```yaml
323-
- uses: prefix-dev/setup-pixi@v0.9.2
325+
- uses: prefix-dev/setup-pixi@v0.9.4
324326
with:
325327
environments: >-
326328
py311
@@ -337,7 +339,7 @@ You can specify whether `setup-pixi` should run `pixi install --frozen` or `pixi
337339
See the [official documentation](../../reference/cli/pixi/install.md#update-options) for more information about the `--frozen` and `--locked` flags.
338340

339341
```yaml
340-
- uses: prefix-dev/setup-pixi@v0.9.2
342+
- uses: prefix-dev/setup-pixi@v0.9.4
341343
with:
342344
locked: true
343345
# or
@@ -367,7 +369,7 @@ The second type is the debug logging of the pixi executable.
367369
This can be specified by setting the `log-level` input.
368370

369371
```yaml
370-
- uses: prefix-dev/setup-pixi@v0.9.2
372+
- uses: prefix-dev/setup-pixi@v0.9.4
371373
with:
372374
log-level: vvv # (1)!
373375
```
@@ -394,7 +396,7 @@ If nothing is specified, `post-cleanup` will default to `true`.
394396
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.
395397

396398
```yaml
397-
- uses: prefix-dev/setup-pixi@v0.9.2
399+
- uses: prefix-dev/setup-pixi@v0.9.4
398400
with:
399401
post-cleanup: true
400402
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
410412
This can be overwritten by setting the `manifest-path` input argument.
411413

412414
```yaml
413-
- uses: prefix-dev/setup-pixi@v0.9.2
415+
- uses: prefix-dev/setup-pixi@v0.9.4
414416
with:
415417
manifest-path: pyproject.toml
416418
```
417419

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+
418450
### Only install pixi
419451

420452
If you only want to install pixi and not install the current workspace, you can use the `run-install` option.
421453

422454
```yml
423-
- uses: prefix-dev/setup-pixi@v0.9.2
455+
- uses: prefix-dev/setup-pixi@v0.9.4
424456
with:
425457
run-install: false
426458
```
@@ -431,7 +463,7 @@ You can also download pixi from a custom URL by setting the `pixi-url` input arg
431463
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.
432464

433465
```yml
434-
- uses: prefix-dev/setup-pixi@v0.9.2
466+
- uses: prefix-dev/setup-pixi@v0.9.4
435467
with:
436468
pixi-url: https://pixi-mirror.example.com/releases/download/v0.48.0/pixi-x86_64-unknown-linux-musl
437469
pixi-url-headers: '{"Authorization": "Bearer ${{ secrets.PIXI_MIRROR_BEARER_TOKEN }}"}'
@@ -447,7 +479,7 @@ It will be rendered with the following variables:
447479
By default, `pixi-url` is equivalent to the following template:
448480

449481
```yml
450-
- uses: prefix-dev/setup-pixi@v0.9.2
482+
- uses: prefix-dev/setup-pixi@v0.9.4
451483
with:
452484
pixi-url: |
453485
{{#if latest~}}

src/assets/pixi/misc/Community.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,3 +66,4 @@ Masked versions of Python array API standard compatible arrays.
6666
- [pyfixest](https://github.com/py-econometrics/pyfixest): Fast High-Dimensional Fixed Effects Regression in Python following fixest-syntax.
6767
- [geovista](https://github.com/bjlittle/geovista): Cartographic rendering and mesh analytics powered by [PyVista](https://github.com/pyvista/pyvista) 🌍
6868
- [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.

src/assets/pixi/python/tutorial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Pixi builds upon the conda ecosystem, which allows you to create a Python enviro
77
This is especially useful when you are working with multiple Python interpreters and bindings to C and C++ libraries.
88
For example, GDAL from PyPI does not have binary C dependencies, but the conda package does.
99
On the other hand, some packages are only available through PyPI, which `pixi` can also install for you.
10-
Best of both world, let's give it a go!
10+
Best of both worlds, let's give it a go!
1111

1212
## `pixi.toml` and `pyproject.toml`
1313

0 commit comments

Comments
 (0)