fix: Behavior if pixi is on path with spaces (#185)

Author: pavelzw

.gitattributes

@@ -1 +1 @@
-dist/** -diff linguist-generated=true
+dist/** merge=binary -diff linguist-generated=true

.github/workflows/test.yml

@@ -247,30 +247,30 @@ jobs:
         run: mv test/default/* .
       - name: Create pixi directory and add to PATH
         run: |
-          mkdir -p $HOME/custom-existing-pixi
-          echo $HOME/custom-existing-pixi >> $GITHUB_PATH
+          mkdir -p "$HOME/custom existing pixi"
+          echo "$HOME/custom existing pixi" >> $GITHUB_PATH
         if: matrix.os != 'windows-latest'
       - name: Create pixi directory and add to PATH (Windows)
         run: |
-          mkdir $env:USERPROFILE\custom-existing-pixi
-          echo $env:USERPROFILE\custom-existing-pixi >> $env:GITHUB_PATH
+          mkdir "$env:USERPROFILE\custom existing pixi"
+          echo "$env:USERPROFILE\custom existing pixi" >> $env:GITHUB_PATH
         shell: pwsh
         if: matrix.os == 'windows-latest'
       - name: Download pixi binary (Ubuntu)
         run: |
           set -o pipefail
-          curl -L --output $HOME/custom-existing-pixi/pixi https://github.com/prefix-dev/pixi/releases/download/v0.14.0/pixi-x86_64-unknown-linux-musl
-          chmod +x $HOME/custom-existing-pixi/pixi
+          curl -L --output "$HOME/custom existing pixi/pixi" https://github.com/prefix-dev/pixi/releases/download/v0.14.0/pixi-x86_64-unknown-linux-musl
+          chmod +x "$HOME/custom existing pixi/pixi"
         if: matrix.os == 'ubuntu-latest'
       - name: Download pixi binary (macOS)
         run: |
           set -o pipefail
-          curl -L --output $HOME/custom-existing-pixi/pixi https://github.com/prefix-dev/pixi/releases/download/v0.14.0/pixi-x86_64-apple-darwin
-          chmod +x $HOME/custom-existing-pixi/pixi
+          curl -L --output "$HOME/custom existing pixi/pixi" https://github.com/prefix-dev/pixi/releases/download/v0.14.0/pixi-x86_64-apple-darwin
+          chmod +x "$HOME/custom existing pixi/pixi"
         if: matrix.os == 'macos-latest'
       - name: Download pixi binary (Windows)
         run: |
-          curl -L --output $HOME/custom-existing-pixi/pixi.exe https://github.com/prefix-dev/pixi/releases/download/v0.14.0/pixi-x86_64-pc-windows-msvc.exe
+          curl -L --output "$HOME/custom existing pixi/pixi.exe" https://github.com/prefix-dev/pixi/releases/download/v0.14.0/pixi-x86_64-pc-windows-msvc.exe
         if: matrix.os == 'windows-latest'
       - run: |
           echo "Path: $PATH"
@@ -282,7 +282,7 @@ jobs:
         shell: bash
       - name: Verify pixi path (before setup-pixi)
         run: |
-          which pixi | grep -q $HOME/custom-existing-pixi/pixi
+          which pixi | grep -q "$HOME/custom existing pixi/pixi"
         shell: bash
       - name: Run Action (should use preinstalled pixi)
         uses: ./
@@ -346,12 +346,12 @@ jobs:
         if: matrix.ignore-reason == 'bin-path' || matrix.ignore-reason == 'version-latest'
       - name: Verify pixi path (after setup-pixi, no ignore reason)
         run: |
-          which pixi | grep -q $HOME/custom-existing-pixi/pixi
+          which pixi | grep -q "$HOME/custom existing pixi/pixi"
         shell: bash
         if: matrix.ignore-reason == 'none'
       - name: Verify pixi path (after setup-pixi, ignore reason)
         run: |
-          which pixi | grep -vq $HOME/custom-existing-pixi/pixi
+          which pixi | grep -vq "$HOME/custom existing pixi/pixi"
         shell: bash
         if: matrix.ignore-reason != 'none'
 

README.md

@@ -23,9 +23,9 @@ GitHub Action to set up the [pixi](https://github.com/prefix-dev/pixi) package m
 ## Usage
 
 ```yml
-- uses: prefix-dev/[email protected].3
+- uses: prefix-dev/[email protected].4
   with:
-    pixi-version: v0.41.4
+    pixi-version: v0.44.0
 
     cache: true
     auth-host: prefix.dev
@@ -35,7 +35,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/[email protected].3`) to avoid breaking changes.
+> Please pin the versions of this action to a specific version (i.e., `prefix-dev/[email protected].4`) 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:
@@ -74,7 +74,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/[email protected].3
+- uses: prefix-dev/[email protected].4
   with:
     cache: true
     cache-write: ${{ github.event_name == 'push' && github.ref_name == 'main' }}
@@ -119,7 +119,7 @@ test:
       environment: [py311, py312]
   steps:
     - uses: actions/checkout@v4
-    - uses: prefix-dev/[email protected].3
+    - uses: prefix-dev/[email protected].4
       with:
         environments: ${{ matrix.environment }}
 ```
@@ -129,7 +129,7 @@ test:
 The following example will install both the `py311` and the `py312` environment on the runner.
 
 ```yml
-- uses: prefix-dev/[email protected].3
+- uses: prefix-dev/[email protected].4
   with:
     # separated by spaces
     environments: >-
@@ -165,7 +165,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/[email protected].3
+- uses: prefix-dev/[email protected].4
   with:
     auth-host: prefix.dev
     auth-token: ${{ secrets.PREFIX_DEV_TOKEN }}
@@ -177,7 +177,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/[email protected].3
+- uses: prefix-dev/[email protected].4
   with:
     auth-host: custom-artifactory.com
     auth-username: ${{ secrets.PIXI_USERNAME }}
@@ -190,7 +190,7 @@ 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](https://anaconda.org) or with [quetz instances](https://github.com/mamba-org/quetz).
 
 ```yml
-- uses: prefix-dev/[email protected].3
+- uses: prefix-dev/[email protected].4
   with:
     auth-host: anaconda.org # or my-quetz-instance.com
     auth-conda-token: ${{ secrets.CONDA_TOKEN }}
@@ -202,7 +202,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/[email protected].3
+- uses: prefix-dev/[email protected].4
   with:
     auth-host: s3://my-s3-bucket
     auth-s3-access-key-id: ${{ secrets.ACCESS_KEY_ID }}
@@ -274,15 +274,15 @@ 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/[email protected].3
+- uses: prefix-dev/[email protected].4
   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.
 
 ```yml
-- uses: prefix-dev/[email protected].3
+- uses: prefix-dev/[email protected].4
   with:
     environments: >-
       py311
@@ -299,7 +299,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/[email protected].3
+- uses: prefix-dev/[email protected].4
   with:
     locked: true
     # or
@@ -318,7 +318,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/[email protected].3
+- uses: prefix-dev/[email protected].4
   env:
     RUNNER_DEBUG: true
 ```
@@ -336,7 +336,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/[email protected].3
+- uses: prefix-dev/[email protected].4
   with:
     # one of `q`, `default`, `v`, `vv`, or `vvv`.
     log-level: vvv
@@ -362,7 +362,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/[email protected].3
+- uses: prefix-dev/[email protected].4
   with:
     post-cleanup: true
     # ${{ runner.temp }}\Scripts\pixi.exe on Windows
@@ -378,7 +378,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/[email protected].3
+- uses: prefix-dev/[email protected].4
   with:
     manifest-path: pyproject.toml
 ```
@@ -388,7 +388,7 @@ This can be overwritten by setting the `manifest-path` input argument.
 If you only want to install pixi and not install the current project, you can use the `run-install` option.
 
 ```yml
-- uses: prefix-dev/[email protected].3
+- uses: prefix-dev/[email protected].4
   with:
     run-install: false
 ```

dist/index.js

@@ -1,6 +1,6 @@
 {
   "name": "setup-pixi",
-  "version": "0.8.3",
+  "version": "0.8.4",
   "private": true,
   "description": "Action to set up the pixi package manager.",
   "scripts": {

package.json

@@ -70,13 +70,17 @@ export const sha256Short = (s: BinaryLike) => {
 }
 
 export const execute = (cmd: string[]) => {
-  core.debug(`Executing: ${cmd.join(' ')}`)
-  return exec(cmd[0], cmd.slice(1))
+  core.debug(`Executing: \`${cmd.toString()}\``)
+  // needs escaping if cmd[0] contains spaces
+  // https://github.com/prefix-dev/setup-pixi/issues/184#issuecomment-2765724843
+  return exec(`"${cmd[0]}"`, cmd.slice(1))
 }
 
 export const executeGetOutput = (cmd: string[], options?: ExecOptions) => {
-  core.debug(`Executing: ${cmd.join(' ')}`)
-  return getExecOutput(cmd[0], cmd.slice(1), options)
+  core.debug(`Executing: \`${cmd.toString()}\``)
+  // needs escaping if cmd[0] contains spaces
+  // https://github.com/prefix-dev/setup-pixi/issues/184#issuecomment-2765724843
+  return getExecOutput(`"${cmd[0]}"`, cmd.slice(1), options)
 }
 
 export const pixiCmd = (command: string, withManifestPath = true) => {