Skip to content

Commit a09b624

Browse files
Hofer-JulianHofer-Julian
authored
feat: change post-cleanup default to false (#272)
1 parent 947fc1f commit a09b624

6 files changed

Lines changed: 30 additions & 30 deletions

File tree

‎README.md‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ GitHub Action to set up the [pixi](https://github.com/prefix-dev/pixi) package m
2323
## Usage
2424

2525
```yml
26-
- uses: prefix-dev/setup-pixi@v0.9.6
26+
- uses: prefix-dev/setup-pixi@v0.10.0
2727
with:
2828
pixi-version: v0.66.0
2929

@@ -35,7 +35,7 @@ GitHub Action to set up the [pixi](https://github.com/prefix-dev/pixi) package m
3535
3636
> [!WARNING]
3737
> Since pixi is not yet stable, the API of this action may change between minor versions.
38-
> Please pin the versions of this action to a specific version (i.e., `prefix-dev/setup-pixi@v0.9.6`) to avoid breaking changes.
38+
> Please pin the versions of this action to a specific version (i.e., `prefix-dev/setup-pixi@v0.10.0`) to avoid breaking changes.
3939
> 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).
4040
>
4141
> Put the following in your `.github/dependabot.yml` file to enable Dependabot for your GitHub Actions:
@@ -79,7 +79,7 @@ In order to not exceed the [10 GB cache size limit](https://docs.github.com/en/a
7979
This can be done by setting the `cache-write` argument.
8080

8181
```yml
82-
- uses: prefix-dev/setup-pixi@v0.9.6
82+
- uses: prefix-dev/setup-pixi@v0.10.0
8383
with:
8484
cache: true
8585
cache-write: ${{ github.event_name == 'push' && github.ref_name == 'main' }}
@@ -124,7 +124,7 @@ test:
124124
environment: [py311, py312]
125125
steps:
126126
- uses: actions/checkout@v4
127-
- uses: prefix-dev/setup-pixi@v0.9.6
127+
- uses: prefix-dev/setup-pixi@v0.10.0
128128
with:
129129
environments: ${{ matrix.environment }}
130130
```
@@ -134,7 +134,7 @@ test:
134134
The following example will install both the `py311` and the `py312` environment on the runner.
135135

136136
```yml
137-
- uses: prefix-dev/setup-pixi@v0.9.6
137+
- uses: prefix-dev/setup-pixi@v0.10.0
138138
with:
139139
# separated by spaces
140140
environments: >-
@@ -157,7 +157,7 @@ For instance, the `keyring`, or `gcloud` executables. The following example show
157157
By default, global environments are not cached. You can enable caching by setting the `global-cache` input to `true`.
158158

159159
```yml
160-
- uses: prefix-dev/setup-pixi@v0.9.6
160+
- uses: prefix-dev/setup-pixi@v0.10.0
161161
with:
162162
global-environments: |
163163
google-cloud-sdk
@@ -190,7 +190,7 @@ Specify the token using the `auth-token` input argument.
190190
This form of authentication (bearer token in the request headers) is mainly used at [prefix.dev](https://prefix.dev).
191191

192192
```yml
193-
- uses: prefix-dev/setup-pixi@v0.9.6
193+
- uses: prefix-dev/setup-pixi@v0.10.0
194194
with:
195195
auth-host: prefix.dev
196196
auth-token: ${{ secrets.PREFIX_DEV_TOKEN }}
@@ -202,7 +202,7 @@ Specify the username and password using the `auth-username` and `auth-password`
202202
This form of authentication (HTTP Basic Auth) is used in some enterprise environments with [artifactory](https://jfrog.com/artifactory) for example.
203203

204204
```yml
205-
- uses: prefix-dev/setup-pixi@v0.9.6
205+
- uses: prefix-dev/setup-pixi@v0.10.0
206206
with:
207207
auth-host: custom-artifactory.com
208208
auth-username: ${{ secrets.PIXI_USERNAME }}
@@ -215,7 +215,7 @@ Specify the conda-token using the `auth-conda-token` input argument.
215215
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).
216216

217217
```yml
218-
- uses: prefix-dev/setup-pixi@v0.9.6
218+
- uses: prefix-dev/setup-pixi@v0.10.0
219219
with:
220220
auth-host: anaconda.org # or my-quetz-instance.com
221221
auth-conda-token: ${{ secrets.CONDA_TOKEN }}
@@ -227,7 +227,7 @@ Specify the S3 key pair using the `auth-access-key-id` and `auth-secret-access-k
227227
You can also specify the session token using the `auth-session-token` input argument.
228228

229229
```yaml
230-
- uses: prefix-dev/setup-pixi@v0.9.6
230+
- uses: prefix-dev/setup-pixi@v0.10.0
231231
with:
232232
auth-host: s3://my-s3-bucket
233233
auth-s3-access-key-id: ${{ secrets.ACCESS_KEY_ID }}
@@ -246,7 +246,7 @@ then run `pixi auth logout <auth-host>` after `pixi install` has completed but b
246246
returns, so that later steps cannot reach the private channel anymore.
247247

248248
```yml
249-
- uses: prefix-dev/setup-pixi@v0.9.6
249+
- uses: prefix-dev/setup-pixi@v0.10.0
250250
with:
251251
auth-host: prefix.dev
252252
auth-token: ${{ secrets.PREFIX_DEV_TOKEN }}
@@ -258,7 +258,7 @@ returns, so that later steps cannot reach the private channel anymore.
258258
You can specify whether to use keyring to look up credentials for PyPI.
259259

260260
```yml
261-
- uses: prefix-dev/setup-pixi@v0.9.6
261+
- uses: prefix-dev/setup-pixi@v0.10.0
262262
with:
263263
pypi-keyring-provider: subprocess # one of 'subprocess', 'disabled'
264264
```
@@ -326,15 +326,15 @@ To this end, `setup-pixi` adds all environment variables set when executing `pix
326326
As a result, all installed binaries can be accessed without having to call `pixi run`.
327327

328328
```yml
329-
- uses: prefix-dev/setup-pixi@v0.9.6
329+
- uses: prefix-dev/setup-pixi@v0.10.0
330330
with:
331331
activate-environment: true
332332
```
333333

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

336336
```yml
337-
- uses: prefix-dev/setup-pixi@v0.9.6
337+
- uses: prefix-dev/setup-pixi@v0.10.0
338338
with:
339339
environments: >-
340340
py311
@@ -351,7 +351,7 @@ You can specify whether `setup-pixi` should run `pixi install --frozen` or `pixi
351351
See the [official documentation](https://pixi.sh/latest/reference/cli/pixi/install/#update-options) for more information about the `--frozen` and `--locked` flags.
352352

353353
```yml
354-
- uses: prefix-dev/setup-pixi@v0.9.6
354+
- uses: prefix-dev/setup-pixi@v0.10.0
355355
with:
356356
locked: true
357357
# or
@@ -370,7 +370,7 @@ The first one is the debug logging of the action itself.
370370
This can be enabled by running the action with the `RUNNER_DEBUG` environment variable set to `true`.
371371

372372
```yml
373-
- uses: prefix-dev/setup-pixi@v0.9.6
373+
- uses: prefix-dev/setup-pixi@v0.10.0
374374
env:
375375
RUNNER_DEBUG: true
376376
```
@@ -388,7 +388,7 @@ The second type is the debug logging of the pixi executable.
388388
This can be specified by setting the `log-level` input.
389389

390390
```yml
391-
- uses: prefix-dev/setup-pixi@v0.9.6
391+
- uses: prefix-dev/setup-pixi@v0.10.0
392392
with:
393393
# one of `q`, `default`, `v`, `vv`, or `vvv`.
394394
log-level: vvv
@@ -409,12 +409,12 @@ If you set `post-cleanup` to `true`, the action will delete the following files:
409409
- the rattler cache
410410
- other rattler files in `~/.rattler`
411411

412-
If nothing is specified, `post-cleanup` will default to `true`.
412+
If nothing is specified, `post-cleanup` will default to `false`.
413413

414414
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.
415415

416416
```yml
417-
- uses: prefix-dev/setup-pixi@v0.9.6
417+
- uses: prefix-dev/setup-pixi@v0.10.0
418418
with:
419419
post-cleanup: true
420420
# ${{ runner.temp }}\Scripts\pixi.exe on Windows
@@ -430,7 +430,7 @@ You can also use a preinstalled local version of pixi on the runner by not setti
430430
This can be overwritten by setting the `manifest-path` input argument.
431431

432432
```yml
433-
- uses: prefix-dev/setup-pixi@v0.9.6
433+
- uses: prefix-dev/setup-pixi@v0.10.0
434434
with:
435435
manifest-path: pyproject.toml
436436
```
@@ -440,7 +440,7 @@ This can be overwritten by setting the `manifest-path` input argument.
440440
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`).
441441

442442
```yml
443-
- uses: prefix-dev/setup-pixi@v0.9.6
443+
- uses: prefix-dev/setup-pixi@v0.10.0
444444
with:
445445
working-directory: ./packages/my-project
446446
```
@@ -459,7 +459,7 @@ This will make pixi look for `pixi.toml` or `pyproject.toml` in the `./packages/
459459
You can combine `working-directory` with `manifest-path` if needed:
460460

461461
```yml
462-
- uses: prefix-dev/setup-pixi@v0.9.6
462+
- uses: prefix-dev/setup-pixi@v0.10.0
463463
with:
464464
working-directory: ./packages/my-project
465465
manifest-path: custom-pixi.toml
@@ -470,7 +470,7 @@ You can combine `working-directory` with `manifest-path` if needed:
470470
If you only want to install pixi and not install the current project, you can use the `run-install` option.
471471

472472
```yml
473-
- uses: prefix-dev/setup-pixi@v0.9.6
473+
- uses: prefix-dev/setup-pixi@v0.10.0
474474
with:
475475
run-install: false
476476
```
@@ -481,7 +481,7 @@ You can also download pixi from a custom URL by setting the `pixi-url` input arg
481481
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.
482482

483483
```yml
484-
- uses: prefix-dev/setup-pixi@v0.9.6
484+
- uses: prefix-dev/setup-pixi@v0.10.0
485485
with:
486486
pixi-url: https://pixi-mirror.example.com/releases/download/v0.48.0/pixi-x86_64-unknown-linux-musl
487487
pixi-url-headers: '{"Authorization": "Bearer ${{ secrets.PIXI_MIRROR_BEARER_TOKEN }}"}'
@@ -497,7 +497,7 @@ It will be rendered with the following variables:
497497
By default, `pixi-url` is equivalent to the following template:
498498

499499
```yml
500-
- uses: prefix-dev/setup-pixi@v0.9.6
500+
- uses: prefix-dev/setup-pixi@v0.10.0
501501
with:
502502
pixi-url: |
503503
{{#if latest~}}

‎action.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ inputs:
9090
options: disabled, subprocess
9191
post-cleanup:
9292
description: |
93-
If the action should clean up after itself. Defaults to `true`.
93+
If the action should clean up after itself. Defaults to `false`.
9494
If `true`, the pixi environment, the pixi binary and the rattler files in ~/.rattler and ~/.cache/rattler are removed.
9595
9696
runs:

‎dist/index.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/post.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "setup-pixi",
3-
"version": "0.9.6",
3+
"version": "0.10.0",
44
"private": true,
55
"description": "Action to set up the pixi package manager.",
66
"scripts": {

‎src/options.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -390,7 +390,7 @@ const inferOptions = (inputs: Inputs): Options => {
390390
s3SessionToken: inputs.authS3SessionToken,
391391
persistCredentials: persistCredentials
392392
}) as Auth)
393-
const postCleanup = inputs.postCleanup ?? true
393+
const postCleanup = inputs.postCleanup ?? false
394394
const pypiKeyringProvider = inputs.pypiKeyringProvider
395395
return {
396396
globalEnvironments: inputs.globalEnvironments,

0 commit comments

Comments
 (0)