GitHub Action to set up the pixi package manager.
- uses: prefix-dev/setup-pixi@v0.8.11
with:
pixi-version: v0.49.0
cache: true
auth-host: prefix.dev
auth-token: ${{ secrets.PREFIX_DEV_TOKEN }}
- run: pixi run test
Warning
Since pixi is not yet stable, 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.8.11) to avoid breaking changes. You can automatically update the version of this action by using Dependabot.
Put the following in your .github/dependabot.yml file to enable Dependabot for your GitHub Actions:
version: 2
updates:
- package-ecosystem: github-actions
directory: /
schedule:
interval: monthly # or daily, weekly
groups:
dependencies:
patterns:
- '*'
To see all available input arguments, see the action.yml file.
The action supports caching of the pixi environment. By default, caching is enabled if a pixi.lock file is present. It will then use the pixi.lock file to generate a hash of the environment and cache it. If the cache is hit, the action will skip the installation and use the cached environment. You can specify the behavior by setting the cache input argument.
If you need to customize your cache-key, you can use the cache-key input argument. This will be the prefix of the cache key. The full cache key will be <cache-key><conda-arch>-<hash>.
In order to not exceed the 10 GB cache size limit as fast, you might want to restrict when the cache is saved. This can be done by setting the cache-write argument.
- uses: prefix-dev/setup-pixi@v0.8.11
with:
cache: true
cache-write: ${{ github.event_name == 'push' && github.ref_name == 'main' }}
With pixi, you can create multiple environments for different requirements. You can also specify which environment(s) you want to install by setting the environments input argument. This will install all environments that are specified and cache them.
[project] name = "my-package" channels = ["conda-forge"] platforms = ["linux-64"] [dependencies] python = ">=3.11" pip = "*" polars = ">=0.14.24,<0.21" [feature.py311.dependencies] python = "3.11.*" [feature.py312.dependencies] python = "3.12.*" [environments] py311 = ["py311"] py312 = ["py312"]Multiple environments using a matrix
The following example will install the py311 and py312 environments in different jobs.
test:
runs-on: ubuntu-latest
strategy:
matrix:
environment: [py311, py312]
steps:
- uses: actions/checkout@v4
- uses: prefix-dev/setup-pixi@v0.8.11
with:
environments: ${{ matrix.environment }} Install multiple environments in one job
The following example will install both the py311 and the py312 environment on the runner.
- uses: prefix-dev/setup-pixi@v0.8.11
with:
# separated by spaces
environments: >-
py311
py312
- run: |
pixi run -e py311 test
pixi run -e py312 test
Warning
If you don't specify any environment, the default environment will be installed and cached, even if you use other environments.
There are currently three ways to authenticate with pixi:
For more information, see the pixi documentation.
Warning
Please only store sensitive information using GitHub secrets. Do not store them in your repository. When your sensitive information is stored in a GitHub secret, you can access it using the ${{ secrets.SECRET_NAME }} syntax. These secrets will always be masked in the logs.
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.
- uses: prefix-dev/setup-pixi@v0.8.11
with:
auth-host: prefix.dev
auth-token: ${{ secrets.PREFIX_DEV_TOKEN }}
Specify the username and password using the auth-username and auth-password input arguments. This form of authentication (HTTP Basic Auth) is used in some enterprise environments with artifactory for example.
- uses: prefix-dev/setup-pixi@v0.8.11
with:
auth-host: custom-artifactory.com
auth-username: ${{ secrets.PIXI_USERNAME }}
auth-password: ${{ secrets.PIXI_PASSWORD }}
Specify the conda-token using the auth-conda-token input argument. This form of authentication (token is encoded in URL: https://my-quetz-instance.com/t/<token>/get/custom-channel) is used at anaconda.org or with quetz instances.
- uses: prefix-dev/setup-pixi@v0.8.11
with:
auth-host: anaconda.org # or my-quetz-instance.com
auth-conda-token: ${{ secrets.CONDA_TOKEN }}
Specify the S3 key pair using the auth-access-key-id and auth-secret-access-key input arguments. You can also specify the session token using the auth-session-token input argument.
- uses: prefix-dev/setup-pixi@v0.8.11
with:
auth-host: s3://my-s3-bucket
auth-s3-access-key-id: ${{ secrets.ACCESS_KEY_ID }}
auth-s3-secret-access-key: ${{ secrets.SECRET_ACCESS_KEY }}
# only needed if your key uses a session token
auth-s3-session-token: ${{ secrets.SESSION_TOKEN }}
See the pixi documentation for more information about S3 authentication.
setup-pixi allows you to run command inside of the pixi environment by specifying a custom shell wrapper with shell: pixi run bash -e {0}. This can be useful if you want to run commands inside of the pixi environment, but don't want to use the pixi run command for each command.
- run: | # everything here will be run inside of the pixi environment
python --version
pip install --no-deps -e .
shell: pixi run bash -e {0}
You can even run Python scripts like this:
- run: | # everything here will be run inside of the pixi environment
import my_package
print("Hello world!")
shell: pixi run python {0}
If you want to use PowerShell, you need to specify -Command as well.
- run: | # everything here will be run inside of the pixi environment
python --version | Select-String "3.11"
shell: pixi run pwsh -Command {0} # pwsh works on all platforms
Note
Under the hood, the shell: xyz {0} option is implemented by creating a temporary script file and calling xyz with that script file as an argument. This file does not have the executable bit set, so you cannot use shell: pixi run {0} directly but instead have to use shell: pixi run bash {0}. There are some custom shells provided by GitHub that have slightly different behavior, see jobs.<job_id>.steps[*].shell in the documentation. See the official documentation and ADR 0277 for more information about how the shell: input works in GitHub Actions.
pixi exec
With pixi exec, you can also run a one-off command inside a temporary pixi environment.
- run: | # everything here will be run inside of the temporary pixi environment
zstd --version
shell: pixi exec --spec zstd -- bash -e {0}
- run: | # everything here will be run inside of the temporary pixi environment
import ruamel.yaml
# ...
shell: pixi exec --spec python=3.11.* --spec ruamel.yaml -- python {0}
See here for more information about pixi exec.
Instead of using a custom shell wrapper, you can also make all pixi-installed binaries available to subsequent steps by "activating" the installed environment in the currently running job. To this end, setup-pixi adds all environment variables set when executing pixi run to $GITHUB_ENV and, similarly, adds all path modifications to $GITHUB_PATH. As a result, all installed binaries can be accessed without having to call pixi run.
- uses: prefix-dev/setup-pixi@v0.8.11
with:
activate-environment: true
If you are installing multiple environments, you will need to specify the name of the environment that you want to be activated.
- uses: prefix-dev/setup-pixi@v0.8.11
with:
environments: >-
py311
py312
activate-environment: py311
Activating an environment may be more useful than using a custom shell wrapper as it allows non-shell based steps to access binaries on the path. However, be aware that this option augments the environment of your job.
You can specify whether setup-pixi should run pixi install --frozen or pixi install --locked depending on the frozen or the locked input argument. See the official documentation for more information about the --frozen and --locked flags.
- uses: prefix-dev/setup-pixi@v0.8.11
with:
locked: true
# or
frozen: true
If you don't specify anything, the default behavior is to run pixi install --locked if a pixi.lock file is present and pixi install otherwise.
There are two types of debug logging that you can enable.
Debug logging of the actionThe first one is the debug logging of the action itself. This can be enabled by running the action with the RUNNER_DEBUG environment variable set to true.
- uses: prefix-dev/setup-pixi@v0.8.11
env:
RUNNER_DEBUG: true
Alternatively, you can enable debug logging for the action by re-running the action in debug mode:
For more information about debug logging in GitHub Actions, see the official documentation.
The second type is the debug logging of the pixi executable. This can be specified by setting the log-level input.
- uses: prefix-dev/setup-pixi@v0.8.11
with:
# one of `q`, `default`, `v`, `vv`, or `vvv`.
log-level: vvv
If nothing is specified, log-level will default to default or vv depending on if debug logging is enabled for the action.
On self-hosted runners, it may happen that some files are persisted between jobs. This can lead to problems or secrets getting leaked between job runs. To avoid this, you can use the post-cleanup input to specify the post cleanup behavior of the action (i.e., what happens after all your commands have been executed).
If you set post-cleanup to true, the action will delete the following files:
.pixi environment~/.rattlerIf nothing is specified, post-cleanup will default to true.
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.
- uses: prefix-dev/setup-pixi@v0.8.11
with:
post-cleanup: true
# ${{ runner.temp }}\Scripts\pixi.exe on Windows
pixi-bin-path: ${{ runner.temp }}/bin/pixi
You can also use a preinstalled local version of pixi on the runner by not setting any of the pixi-version, pixi-url or pixi-bin-path inputs. This action will then try to find a local version of pixi in the runner's PATH.
pyproject.toml as a manifest file for pixi
setup-pixi will automatically pick up the pyproject.toml if it contains a [tool.pixi.project] section and no pixi.toml. This can be overwritten by setting the manifest-path input argument.
- uses: prefix-dev/setup-pixi@v0.8.11
with:
manifest-path: pyproject.toml
If you only want to install pixi and not install the current project, you can use the run-install option.
- uses: prefix-dev/setup-pixi@v0.8.11
with:
run-install: false 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-bearer-token input argument to authenticate the download request.
- uses: prefix-dev/setup-pixi@v0.8.11
with:
pixi-url: https://pixi-mirror.example.com/releases/download/v0.48.0/pixi-x86_64-unknown-linux-musl
pixi-url-bearer-token: ${{ secrets.PIXI_MIRROR_BEARER_TOKEN }}
If you want to see more examples, you can take a look at the GitHub Workflows of this repository.
pnpm install inside the repository (if you don't have pnpm installed, you can install it with pixi global install pnpm).pnpm dev for live transpilation of the TypeScript source code.act (inside docker) or use ✨ CI driven development ✨.RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4