mirror of
https://github.com/prefix-dev/setup-pixi
synced 2026-05-23 15:03:51 +03:00
fix: use iarna/toml instead of toml (#118)
This commit is contained in:
Ruben Arts
@@ -18,7 +18,7 @@ jobs:
|
||||
- name: Install pnpm
|
||||
uses: pnpm/action-setup@v4
|
||||
with:
|
||||
version: 8
|
||||
version: 9
|
||||
|
||||
- name: Install Node.js
|
||||
uses: actions/setup-node@v4
|
||||
@@ -92,7 +92,7 @@ jobs:
|
||||
- name: Install pnpm
|
||||
uses: pnpm/action-setup@v4
|
||||
with:
|
||||
version: 8
|
||||
version: 9
|
||||
|
||||
- name: Install Node.js
|
||||
uses: actions/setup-node@v4
|
||||
|
||||
@@ -23,9 +23,9 @@ GitHub Action to set up the [pixi](https://github.com/prefix-dev/pixi) package m
|
||||
## Usage
|
||||
|
||||
```yml
|
||||
- uses: prefix-dev/setup-pixi@v0.8.0
|
||||
- uses: prefix-dev/setup-pixi@v0.8.1
|
||||
with:
|
||||
pixi-version: v0.22.0
|
||||
pixi-version: v0.23.0
|
||||
cache: true
|
||||
auth-host: prefix.dev
|
||||
auth-token: ${{ secrets.PREFIX_DEV_TOKEN }}
|
||||
@@ -34,7 +34,7 @@ GitHub Action to set up the [pixi](https://github.com/prefix-dev/pixi) package m
|
||||
|
||||
> [!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.0`) to avoid breaking changes.
|
||||
> Please pin the versions of this action to a specific version (i.e., `prefix-dev/setup-pixi@v0.8.1`) 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:
|
||||
@@ -73,7 +73,7 @@ In order to not exceed the [10 GB cache size limit](https://docs.github.com/en/a
|
||||
This can be done by setting the `cache-write` argument.
|
||||
|
||||
```yml
|
||||
- uses: prefix-dev/setup-pixi@v0.8.0
|
||||
- uses: prefix-dev/setup-pixi@v0.8.1
|
||||
with:
|
||||
cache: true
|
||||
cache-write: ${{ github.event_name == 'push' && github.ref_name == 'main' }}
|
||||
@@ -118,7 +118,7 @@ test:
|
||||
environment: [py311, py312]
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: prefix-dev/setup-pixi@v0.8.0
|
||||
- uses: prefix-dev/setup-pixi@v0.8.1
|
||||
with:
|
||||
environments: ${{ matrix.environment }}
|
||||
```
|
||||
@@ -128,7 +128,7 @@ test:
|
||||
The following example will install both the `py311` and the `py312` environment on the runner.
|
||||
|
||||
```yml
|
||||
- uses: prefix-dev/setup-pixi@v0.8.0
|
||||
- uses: prefix-dev/setup-pixi@v0.8.1
|
||||
with:
|
||||
# separated by spaces
|
||||
environments: >-
|
||||
@@ -163,7 +163,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).
|
||||
|
||||
```yml
|
||||
- uses: prefix-dev/setup-pixi@v0.8.0
|
||||
- uses: prefix-dev/setup-pixi@v0.8.1
|
||||
with:
|
||||
auth-host: prefix.dev
|
||||
auth-token: ${{ secrets.PREFIX_DEV_TOKEN }}
|
||||
@@ -175,7 +175,7 @@ Specify the username and password using the `auth-username` and `auth-password`
|
||||
This form of authentication (HTTP Basic Auth) is used in some enterprise environments with [artifactory](https://jfrog.com/artifactory) for example.
|
||||
|
||||
```yml
|
||||
- uses: prefix-dev/setup-pixi@v0.8.0
|
||||
- uses: prefix-dev/setup-pixi@v0.8.1
|
||||
with:
|
||||
auth-host: custom-artifactory.com
|
||||
auth-username: ${{ secrets.PIXI_USERNAME }}
|
||||
@@ -188,7 +188,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/<token>/get/custom-channel`) is used at [anaconda.org](https://anaconda.org) or with [quetz instances](https://github.com/mamba-org/quetz).
|
||||
|
||||
```yml
|
||||
- uses: prefix-dev/setup-pixi@v0.8.0
|
||||
- uses: prefix-dev/setup-pixi@v0.8.1
|
||||
with:
|
||||
auth-host: anaconda.org # or my-quetz-instance.com
|
||||
conda-token: ${{ secrets.CONDA_TOKEN }}
|
||||
@@ -235,7 +235,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`.
|
||||
|
||||
```yml
|
||||
- uses: prefix-dev/setup-pixi@v0.8.0
|
||||
- uses: prefix-dev/setup-pixi@v0.8.1
|
||||
with:
|
||||
activate-environment: true
|
||||
```
|
||||
@@ -243,7 +243,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.
|
||||
|
||||
```yml
|
||||
- uses: prefix-dev/setup-pixi@v0.8.0
|
||||
- uses: prefix-dev/setup-pixi@v0.8.1
|
||||
with:
|
||||
environments: >-
|
||||
py311
|
||||
@@ -260,7 +260,7 @@ You can specify whether `setup-pixi` should run `pixi install --frozen` or `pixi
|
||||
See the [official documentation](https://prefix.dev/docs/pixi/cli#install) for more information about the `--frozen` and `--locked` flags.
|
||||
|
||||
```yml
|
||||
- uses: prefix-dev/setup-pixi@v0.8.0
|
||||
- uses: prefix-dev/setup-pixi@v0.8.1
|
||||
with:
|
||||
locked: true
|
||||
# or
|
||||
@@ -279,7 +279,7 @@ The 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`.
|
||||
|
||||
```yml
|
||||
- uses: prefix-dev/setup-pixi@v0.8.0
|
||||
- uses: prefix-dev/setup-pixi@v0.8.1
|
||||
env:
|
||||
RUNNER_DEBUG: true
|
||||
```
|
||||
@@ -297,7 +297,7 @@ The second type is the debug logging of the pixi executable.
|
||||
This can be specified by setting the `log-level` input.
|
||||
|
||||
```yml
|
||||
- uses: prefix-dev/setup-pixi@v0.8.0
|
||||
- uses: prefix-dev/setup-pixi@v0.8.1
|
||||
with:
|
||||
# one of `q`, `default`, `v`, `vv`, or `vvv`.
|
||||
log-level: vvv
|
||||
@@ -323,7 +323,7 @@ If 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.
|
||||
|
||||
```yml
|
||||
- uses: prefix-dev/setup-pixi@v0.8.0
|
||||
- uses: prefix-dev/setup-pixi@v0.8.1
|
||||
with:
|
||||
post-cleanup: true
|
||||
# ${{ runner.temp }}\Scripts\pixi.exe on Windows
|
||||
@@ -339,7 +339,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.
|
||||
|
||||
```yml
|
||||
- uses: prefix-dev/setup-pixi@v0.8.0
|
||||
- uses: prefix-dev/setup-pixi@v0.8.1
|
||||
with:
|
||||
manifest-path: pyproject.toml
|
||||
```
|
||||
|
||||
+9731
-11646
File diff suppressed because one or more lines are too long
+19213
-3853
File diff suppressed because one or more lines are too long
+2
-2
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "setup-pixi",
|
||||
"version": "0.8.0",
|
||||
"version": "0.8.1",
|
||||
"private": true,
|
||||
"description": "Action to set up the pixi package manager.",
|
||||
"scripts": {
|
||||
@@ -26,7 +26,7 @@
|
||||
"@actions/exec": "^1.1.1",
|
||||
"@actions/io": "^1.1.3",
|
||||
"@actions/tool-cache": "^2.0.1",
|
||||
"toml": "^3.0.0",
|
||||
"@iarna/toml": "^2.2.5",
|
||||
"untildify": "^5.0.0",
|
||||
"which": "^4.0.0",
|
||||
"zod": "^3.22.4"
|
||||
|
||||
Generated
+2441
-1997
File diff suppressed because it is too large
Load Diff
+22
-15
@@ -5,7 +5,7 @@ import { existsSync, readFileSync } from 'fs'
|
||||
import * as core from '@actions/core'
|
||||
import * as z from 'zod'
|
||||
import untildify from 'untildify'
|
||||
import { parse } from 'toml'
|
||||
import { parse } from '@iarna/toml'
|
||||
import which from 'which'
|
||||
|
||||
type Inputs = Readonly<{
|
||||
@@ -74,6 +74,8 @@ export type Options = Readonly<{
|
||||
postCleanup: boolean
|
||||
activatedEnvironment?: string
|
||||
}>
|
||||
const pixiPath = 'pixi.toml'
|
||||
const pyprojectPath = 'pyproject.toml'
|
||||
|
||||
const logLevelSchema = z.enum(['q', 'default', 'v', 'vv', 'vvv'])
|
||||
export type LogLevel = z.infer<typeof logLevelSchema>
|
||||
@@ -201,26 +203,31 @@ const inferOptions = (inputs: Inputs): Options => {
|
||||
)
|
||||
const logLevel = inputs.logLevel ?? (core.isDebug() ? 'vv' : 'default')
|
||||
// infer manifest path from inputs or default to pixi.toml or pyproject.toml depending on what is present in the repo.
|
||||
let manifestPath = 'pixi.toml' // default
|
||||
let manifestPath = pixiPath // default
|
||||
if (inputs.manifestPath) {
|
||||
manifestPath = path.resolve(untildify(inputs.manifestPath))
|
||||
} else {
|
||||
if (existsSync('pixi.toml')) {
|
||||
manifestPath = 'pixi.toml'
|
||||
} else if (existsSync('pyproject.toml')) {
|
||||
const fileContent = readFileSync('pyproject.toml', 'utf-8')
|
||||
const parsedContent = parse(fileContent)
|
||||
// only use pyproject.toml if [tool.pixi] is present
|
||||
if (parsedContent.tool && parsedContent.tool.pixi) {
|
||||
core.debug('The tool.pixi table found so using pyproject.toml as manifest file.')
|
||||
manifestPath = 'pyproject.toml'
|
||||
}
|
||||
} else {
|
||||
if (runInstall) {
|
||||
core.warning('Could not find any manifest file. Defaulting to pixi.toml.')
|
||||
if (existsSync(pixiPath)) {
|
||||
manifestPath = pixiPath
|
||||
} else if (existsSync(pyprojectPath)) {
|
||||
try {
|
||||
const fileContent = readFileSync(pyprojectPath, 'utf-8')
|
||||
const parsedContent: Record<string, unknown> = parse(fileContent)
|
||||
|
||||
// Test if the tool.pixi table is present in the pyproject.toml file, if so, use it as the manifest file.
|
||||
if (parsedContent?.tool && typeof parsedContent.tool === 'object' && 'pixi' in parsedContent.tool) {
|
||||
core.debug(`The tool.pixi table found, using ${pyprojectPath} as manifest file.`)
|
||||
manifestPath = pyprojectPath
|
||||
}
|
||||
} catch (error) {
|
||||
core.error(`Error while trying to read ${pyprojectPath} file.`)
|
||||
core.error(error as Error)
|
||||
}
|
||||
} else if (runInstall) {
|
||||
core.warning(`Could not find any manifest file. Defaulting to ${pixiPath}.`)
|
||||
}
|
||||
}
|
||||
|
||||
const pixiLockFile = path.join(path.dirname(manifestPath), 'pixi.lock')
|
||||
const lockFileAvailable = existsSync(pixiLockFile)
|
||||
core.debug(`lockFileAvailable: ${lockFileAvailable}`)
|
||||
|
||||
@@ -15,8 +15,9 @@ name = "pyproject-manifest"
|
||||
channels = ["conda-forge"]
|
||||
platforms = ["linux-64", "osx-arm64", "osx-64", "win-64"]
|
||||
|
||||
[tool.pixi.pypi-dependencies]
|
||||
boltons = "*"
|
||||
[tool.pixi]
|
||||
# This dotted inline table fails with the `toml` parser, but works with `@iarna/toml`.
|
||||
pypi-dependencies.boltons = "*"
|
||||
|
||||
[tool.pixi.tasks]
|
||||
test = "echo 'Running tests...'"
|
||||
|
||||
+1
-1
@@ -19,7 +19,7 @@ export default defineConfig({
|
||||
'@actions/io',
|
||||
'@actions/tool-cache',
|
||||
'untildify',
|
||||
'toml',
|
||||
'@iarna/toml',
|
||||
'which',
|
||||
'zod'
|
||||
]
|
||||
|
||||
Reference in New Issue
Block a user