From 7437aa5f0912befdba20f3f86813153f05d1f9bf Mon Sep 17 00:00:00 2001 From: Pavel Zwerschke Date: Sun, 1 Nov 2026 15:25:23 +0100 Subject: [PATCH 1/2] docs(setup-pixi): Document configuration input and bump to v0.11.3 --- docs/integration/ci/github_actions.md | 66 +++++++++++++++++---------- 1 file changed, 41 insertions(+), 25 deletions(-) diff --git a/docs/integration/ci/github_actions.md b/docs/integration/ci/github_actions.md index 225bd01458..0b4919cc37 100644 --- a/docs/integration/ci/github_actions.md +++ b/docs/integration/ci/github_actions.md @@ -8,7 +8,7 @@ We created [prefix-dev/setup-pixi](https://github.com/prefix-dev/setup-pixi) to ## Usage ```yaml -- uses: prefix-dev/setup-pixi@v0.11.1 +- uses: prefix-dev/setup-pixi@v0.11.3 with: pixi-version: v0.83.0 cache: true @@ -19,7 +19,7 @@ We created [prefix-dev/setup-pixi](https://github.com/prefix-dev/setup-pixi) to !!!warning "Pin your action versions" Since setup-pixi uses pre-v1 versioning, the API of this action may change between minor versions. - Please pin the versions of this action to a specific version (i.e., `prefix-dev/setup-pixi@v0.11.1`) to avoid breaking changes. + Please pin the versions of this action to a specific version (i.e., `prefix-dev/setup-pixi@v0.11.3`) to avoid breaking changes. 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). Put the following in your `.github/dependabot.yml` file to enable Dependabot for your GitHub Actions: @@ -66,7 +66,7 @@ As there is no lock file for global environments, the cache will expire at the e This can be done by setting the `cache-write` argument. ```yaml - - uses: prefix-dev/setup-pixi@v0.11.1 + - uses: prefix-dev/setup-pixi@v0.11.3 with: cache: true cache-write: ${{ github.event_name == 'push' && github.ref_name == 'main' }} @@ -107,7 +107,7 @@ test: environment: [py311, py312] steps: - uses: actions/checkout@v4 - - uses: prefix-dev/setup-pixi@v0.11.1 + - uses: prefix-dev/setup-pixi@v0.11.3 with: environments: ${{ matrix.environment }} ``` @@ -117,7 +117,7 @@ test: The following example will install both the `py311` and the `py312` environment on the runner. ```yaml -- uses: prefix-dev/setup-pixi@v0.11.1 +- uses: prefix-dev/setup-pixi@v0.11.3 with: environments: >- # (1)! py311 @@ -145,7 +145,7 @@ For instance, the `keyring`, or `gcloud` executables. The following example show By default, global environments are not cached. You can enable caching by setting the `global-cache` input to `true`. ```yaml -- uses: prefix-dev/setup-pixi@v0.11.1 +- uses: prefix-dev/setup-pixi@v0.11.3 with: global-environments: | google-cloud-sdk @@ -179,7 +179,7 @@ Specify the token using the `auth-token` input argument. This form of authentication (bearer token in the request headers) is mainly used at [prefix.dev](https://prefix.dev). ```yaml -- uses: prefix-dev/setup-pixi@v0.11.1 +- uses: prefix-dev/setup-pixi@v0.11.3 with: auth-host: prefix.dev auth-token: ${{ secrets.PREFIX_DEV_TOKEN }} @@ -190,7 +190,7 @@ This form of authentication (bearer token in the request headers) is mainly used Specify the username and password using the `auth-username` and `auth-password` input arguments. ```yaml -- uses: prefix-dev/setup-pixi@v0.11.1 +- uses: prefix-dev/setup-pixi@v0.11.3 with: auth-host: custom-artifactory.com auth-username: ${{ secrets.PIXI_USERNAME }} @@ -203,7 +203,7 @@ Specify the conda-token using the `conda-token` input argument. This form of authentication (token is encoded in URL: `https://my-quetz-instance.com/t//get/custom-channel`) is used at [anaconda.org](https://anaconda.org) or with [quetz instances](https://github.com/mamba-org/quetz). ```yaml -- uses: prefix-dev/setup-pixi@v0.11.1 +- uses: prefix-dev/setup-pixi@v0.11.3 with: auth-host: anaconda.org # (1)! auth-conda-token: ${{ secrets.CONDA_TOKEN }} @@ -217,7 +217,7 @@ Specify the S3 key pair using the `auth-access-key-id` and `auth-secret-access-k You can also specify the session token using the `auth-session-token` input argument. ```yaml -- uses: prefix-dev/setup-pixi@v0.11.1 +- uses: prefix-dev/setup-pixi@v0.11.3 with: auth-host: s3://my-s3-bucket auth-s3-access-key-id: ${{ secrets.ACCESS_KEY_ID }} @@ -241,7 +241,7 @@ permissions: id-token: write contents: read steps: - - uses: prefix-dev/setup-pixi@v0.11.1 + - uses: prefix-dev/setup-pixi@v0.11.3 with: auth-host: prefix.dev auth-workload-identity: true @@ -256,7 +256,7 @@ You can fine-tune the exchange using the following optional inputs: Defaults to the `token_endpoint` from the host's RFC 8414 metadata. ```yaml -- uses: prefix-dev/setup-pixi@v0.11.1 +- uses: prefix-dev/setup-pixi@v0.11.3 with: auth-host: https://my-org.jfrog.io auth-workload-identity: true @@ -277,7 +277,7 @@ You can change this behavior with the `auth-logout` input: - `never`: never log out, for example on self-hosted runners where the credentials should persist between jobs. ```yaml -- uses: prefix-dev/setup-pixi@v0.11.1 +- uses: prefix-dev/setup-pixi@v0.11.3 with: auth-host: prefix.dev auth-token: ${{ secrets.PREFIX_DEV_TOKEN }} @@ -293,7 +293,7 @@ You can change this behavior with the `auth-logout` input: You can specify whether to use keyring to look up credentials for PyPI. ```yml -- uses: prefix-dev/setup-pixi@v0.11.1 +- uses: prefix-dev/setup-pixi@v0.11.3 with: pypi-keyring-provider: subprocess # one of 'subprocess', 'disabled' ``` @@ -369,7 +369,7 @@ To this end, `setup-pixi` adds all environment variables set when executing `pix As a result, all installed binaries can be accessed without having to call `pixi run`. ```yaml -- uses: prefix-dev/setup-pixi@v0.11.1 +- uses: prefix-dev/setup-pixi@v0.11.3 with: activate-environment: true ``` @@ -377,7 +377,7 @@ As a result, all installed binaries can be accessed without having to call `pixi If you are installing multiple environments, you will need to specify the name of the environment that you want to be activated. ```yaml -- uses: prefix-dev/setup-pixi@v0.11.1 +- uses: prefix-dev/setup-pixi@v0.11.3 with: environments: >- py311 @@ -394,7 +394,7 @@ You can specify whether `setup-pixi` should run `pixi install --frozen` or `pixi See the [official documentation](../../reference/cli/pixi/install.md#update-options) for more information about the `--frozen` and `--locked` flags. ```yaml -- uses: prefix-dev/setup-pixi@v0.11.1 +- uses: prefix-dev/setup-pixi@v0.11.3 with: locked: true # or @@ -424,7 +424,7 @@ The second type is the debug logging of the pixi executable. This can be specified by setting the `log-level` input. ```yaml -- uses: prefix-dev/setup-pixi@v0.11.1 +- uses: prefix-dev/setup-pixi@v0.11.3 with: log-level: vvv # (1)! ``` @@ -451,7 +451,7 @@ If nothing is specified, `post-cleanup` will default to `false`. 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. ```yaml -- uses: prefix-dev/setup-pixi@v0.11.1 +- uses: prefix-dev/setup-pixi@v0.11.3 with: post-cleanup: true pixi-bin-path: ${{ runner.temp }}/bin/pixi # (1)! @@ -467,7 +467,7 @@ You can also use a preinstalled local version of pixi on the runner by not setti This can be overwritten by setting the `manifest-path` input argument. ```yaml -- uses: prefix-dev/setup-pixi@v0.11.1 +- uses: prefix-dev/setup-pixi@v0.11.3 with: manifest-path: pyproject.toml ``` @@ -477,7 +477,7 @@ This can be overwritten by setting the `manifest-path` input argument. 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`). ```yml -- uses: prefix-dev/setup-pixi@v0.11.1 +- uses: prefix-dev/setup-pixi@v0.11.3 with: working-directory: ./packages/my-project ``` @@ -496,7 +496,7 @@ This will make pixi look for `pixi.toml` or `pyproject.toml` in the `./packages/ You can combine `working-directory` with `manifest-path` if needed: ```yml -- uses: prefix-dev/setup-pixi@v0.11.1 +- uses: prefix-dev/setup-pixi@v0.11.3 with: working-directory: ./packages/my-project manifest-path: custom-pixi.toml @@ -507,18 +507,34 @@ You can combine `working-directory` with `manifest-path` if needed: If you only want to install pixi and not install the current workspace, you can use the `run-install` option. ```yml -- uses: prefix-dev/setup-pixi@v0.11.1 +- uses: prefix-dev/setup-pixi@v0.11.3 with: run-install: false ``` +### Global configuration + +You can set [global pixi configuration](../../reference/pixi_configuration.md) using the `configuration` input. +Its content must be valid TOML and is written verbatim to `$PIXI_HOME/config.toml` (`~/.pixi/config.toml` by default) before any pixi command runs. + +```yml +- uses: prefix-dev/setup-pixi@v0.11.3 + with: + configuration: | + run-post-link-scripts = "insecure" +``` + +!!! note + `setup-pixi` refuses to overwrite an existing configuration file and fails if `$PIXI_HOME/config.toml` already exists. + If `post-cleanup` is enabled, the configuration file is removed again in the post step. + ### Download pixi from a custom URL You can also download pixi from a custom URL by setting the `pixi-url` input argument. 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. ```yml -- uses: prefix-dev/setup-pixi@v0.11.1 +- uses: prefix-dev/setup-pixi@v0.11.3 with: pixi-url: https://pixi-mirror.example.com/releases/download/v0.48.0/pixi-x86_64-unknown-linux-musl pixi-url-headers: '{"Authorization": "Bearer ${{ secrets.PIXI_MIRROR_BEARER_TOKEN }}"}' @@ -534,7 +550,7 @@ It will be rendered with the following variables: By default, `pixi-url` is equivalent to the following template: ```yml -- uses: prefix-dev/setup-pixi@v0.11.1 +- uses: prefix-dev/setup-pixi@v0.11.3 with: pixi-url: | {{#if latest~}} From 47879a422b19959f1267a627ea7f827ffd063bc7 Mon Sep 17 00:00:00 2001 From: Pavel Zwerschke Date: Sun, 1 Nov 2026 16:19:20 +0100 Subject: [PATCH 2/2] docs(setup-pixi): Drop configuration note --- docs/integration/ci/github_actions.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/integration/ci/github_actions.md b/docs/integration/ci/github_actions.md index 0b4919cc37..3a09ce9e16 100644 --- a/docs/integration/ci/github_actions.md +++ b/docs/integration/ci/github_actions.md @@ -524,10 +524,6 @@ Its content must be valid TOML and is written verbatim to `$PIXI_HOME/config.tom run-post-link-scripts = "insecure" ``` -!!! note - `setup-pixi` refuses to overwrite an existing configuration file and fails if `$PIXI_HOME/config.toml` already exists. - If `post-cleanup` is enabled, the configuration file is removed again in the post step. - ### Download pixi from a custom URL You can also download pixi from a custom URL by setting the `pixi-url` input argument.