Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit8ca4608

Browse files
authored
feat: Replace pixi-url-bearer-token by pixi-url-headers (#217)
1 parentb1ab8f2 commit8ca4608

File tree

8 files changed

+45
-47
lines changed

8 files changed

+45
-47
lines changed

‎.github/workflows/test.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ jobs:
190190
pixi-url:https://github.com/prefix-dev/pixi/releases/download/v0.14.0/pixi-x86_64-unknown-linux-musl
191191
-run:pixi --version | grep -q "pixi 0.14.0"
192192

193-
pixi-url-bearer-token:
193+
pixi-url-headers-bearer:
194194
runs-on:ubuntu-latest
195195
steps:
196196
-uses:actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683# v4.2.2
@@ -216,7 +216,7 @@ jobs:
216216
with:
217217
cache:false
218218
pixi-url:http://localhost:8080/pixi
219-
pixi-url-bearer-token:wrongtoken
219+
pixi-url-headers:'{"Authorization": "Bearerwrongtoken"}'
220220
continue-on-error:true
221221
-name:Fail if wrong token did not fail
222222
run:|
@@ -228,7 +228,7 @@ jobs:
228228
with:
229229
cache:false
230230
pixi-url:http://localhost:8080/pixi
231-
pixi-url-bearer-token:s3cr3tT0k3nABC123
231+
pixi-url-headers:'{"Authorization": "Bearers3cr3tT0k3nABC123"}'
232232
-run:pixi --version | grep -q "pixi 0.14.0"
233233

234234
pixi-url-custom-template-no-version:

‎README.md‎

Lines changed: 21 additions & 21 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.8.13
26+
-uses:prefix-dev/setup-pixi@v0.8.14
2727
with:
2828
pixi-version:v0.49.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.8.13`) to avoid breaking changes.
38+
> Please pin the versions of this action to a specific version (i.e.,`prefix-dev/setup-pixi@v0.8.14`) 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:
@@ -74,7 +74,7 @@ In order to not exceed the [10 GB cache size limit](https://docs.github.com/en/a
7474
This can be done by setting the `cache-write` argument.
7575

7676
```yml
77-
- uses: prefix-dev/setup-pixi@v0.8.13
77+
- uses: prefix-dev/setup-pixi@v0.8.14
7878
with:
7979
cache: true
8080
cache-write: ${{ github.event_name == 'push' && github.ref_name == 'main' }}
@@ -119,7 +119,7 @@ test:
119119
environment: [py311, py312]
120120
steps:
121121
- uses: actions/checkout@v4
122-
- uses: prefix-dev/setup-pixi@v0.8.13
122+
- uses: prefix-dev/setup-pixi@v0.8.14
123123
with:
124124
environments: ${{ matrix.environment }}
125125
```
@@ -129,7 +129,7 @@ test:
129129
The following example will install both the `py311` and the `py312` environment on the runner.
130130

131131
```yml
132-
- uses: prefix-dev/setup-pixi@v0.8.13
132+
- uses: prefix-dev/setup-pixi@v0.8.14
133133
with:
134134
# separated by spaces
135135
environments: >-
@@ -165,7 +165,7 @@ Specify the token using the `auth-token` input argument.
165165
This form of authentication (bearer token in the request headers) is mainly used at [prefix.dev](https://prefix.dev).
166166

167167
```yml
168-
- uses: prefix-dev/setup-pixi@v0.8.13
168+
- uses: prefix-dev/setup-pixi@v0.8.14
169169
with:
170170
auth-host: prefix.dev
171171
auth-token: ${{ secrets.PREFIX_DEV_TOKEN }}
@@ -177,7 +177,7 @@ Specify the username and password using the `auth-username` and `auth-password`
177177
This form of authentication (HTTP Basic Auth) is used in some enterprise environments with [artifactory](https://jfrog.com/artifactory) for example.
178178

179179
```yml
180-
- uses: prefix-dev/setup-pixi@v0.8.13
180+
- uses: prefix-dev/setup-pixi@v0.8.14
181181
with:
182182
auth-host: custom-artifactory.com
183183
auth-username: ${{ secrets.PIXI_USERNAME }}
@@ -190,7 +190,7 @@ Specify the conda-token using the `auth-conda-token` input argument.
190190
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).
191191

192192
```yml
193-
- uses: prefix-dev/setup-pixi@v0.8.13
193+
- uses: prefix-dev/setup-pixi@v0.8.14
194194
with:
195195
auth-host: anaconda.org # or my-quetz-instance.com
196196
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
202202
You can also specify the session token using the `auth-session-token` input argument.
203203

204204
```yaml
205-
- uses: prefix-dev/setup-pixi@v0.8.13
205+
- uses: prefix-dev/setup-pixi@v0.8.14
206206
with:
207207
auth-host: s3://my-s3-bucket
208208
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
274274
As a result, all installed binaries can be accessed without having to call `pixi run`.
275275

276276
```yml
277-
- uses: prefix-dev/setup-pixi@v0.8.13
277+
- uses: prefix-dev/setup-pixi@v0.8.14
278278
with:
279279
activate-environment: true
280280
```
281281

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

284284
```yml
285-
- uses: prefix-dev/setup-pixi@v0.8.13
285+
- uses: prefix-dev/setup-pixi@v0.8.14
286286
with:
287287
environments: >-
288288
py311
@@ -299,7 +299,7 @@ You can specify whether `setup-pixi` should run `pixi install --frozen` or `pixi
299299
See the [official documentation](https://prefix.dev/docs/pixi/cli#install) for more information about the `--frozen` and `--locked` flags.
300300

301301
```yml
302-
- uses: prefix-dev/setup-pixi@v0.8.13
302+
- uses: prefix-dev/setup-pixi@v0.8.14
303303
with:
304304
locked: true
305305
# or
@@ -318,7 +318,7 @@ The first one is the debug logging of the action itself.
318318
This can be enabled by running the action with the `RUNNER_DEBUG` environment variable set to `true`.
319319

320320
```yml
321-
- uses: prefix-dev/setup-pixi@v0.8.13
321+
- uses: prefix-dev/setup-pixi@v0.8.14
322322
env:
323323
RUNNER_DEBUG: true
324324
```
@@ -336,7 +336,7 @@ The second type is the debug logging of the pixi executable.
336336
This can be specified by setting the `log-level` input.
337337

338338
```yml
339-
- uses: prefix-dev/setup-pixi@v0.8.13
339+
- uses: prefix-dev/setup-pixi@v0.8.14
340340
with:
341341
# one of`q`, `default`, `v`, `vv`, or `vvv`.
342342
log-level:vvv
@@ -362,7 +362,7 @@ If nothing is specified, `post-cleanup` will default to `true`.
362362
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.
363363

364364
```yml
365-
- uses: prefix-dev/setup-pixi@v0.8.13
365+
- uses: prefix-dev/setup-pixi@v0.8.14
366366
with:
367367
post-cleanup: true
368368
# ${{ 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
378378
This can be overwritten by setting the `manifest-path` input argument.
379379

380380
```yml
381-
- uses: prefix-dev/setup-pixi@v0.8.13
381+
- uses: prefix-dev/setup-pixi@v0.8.14
382382
with:
383383
manifest-path: pyproject.toml
384384
```
@@ -388,21 +388,21 @@ This can be overwritten by setting the `manifest-path` input argument.
388388
If you only want to install pixi and not install the current project, you can use the `run-install` option.
389389

390390
```yml
391-
- uses: prefix-dev/setup-pixi@v0.8.13
391+
- uses: prefix-dev/setup-pixi@v0.8.14
392392
with:
393393
run-install: false
394394
```
395395

396396
### Download pixi from a custom URL
397397

398398
You can also download pixi from a custom URL by setting the `pixi-url` input argument.
399-
Optionally, you can combine this with the `pixi-url-bearer-token` input argument toauthenticatethe download request.
399+
Optionally, you can combine this with the `pixi-url-headers` input argument tosupply additional headers forthe download request, such as a bearer token.
400400

401401
```yml
402-
- uses: prefix-dev/setup-pixi@v0.8.13
402+
- uses: prefix-dev/setup-pixi@v0.8.14
403403
with:
404404
pixi-url: https://pixi-mirror.example.com/releases/download/v0.48.0/pixi-x86_64-unknown-linux-musl
405-
pixi-url-bearer-token:${{ secrets.PIXI_MIRROR_BEARER_TOKEN }}
405+
pixi-url-headers: '{"Authorization": "Bearer${{ secrets.PIXI_MIRROR_BEARER_TOKEN }}"}'
406406
```
407407

408408
The `pixi-url` input argument can also be a [Handlebars](https://handlebarsjs.com/) template string.
@@ -415,7 +415,7 @@ It will be rendered with the following variables:
415415
By default, `pixi-url` is equivalent to the following template:
416416

417417
```yml
418-
- uses: prefix-dev/setup-pixi@v0.8.13
418+
- uses: prefix-dev/setup-pixi@v0.8.14
419419
with:
420420
pixi-url: |
421421
{{#if latest~}}

‎action.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ inputs:
1010
description:Version of pixi to install
1111
pixi-url:
1212
description:URL of pixi to install. Can be a Handlebars template receiving `version`, `latest`, and `pixiFile` as variables.
13-
pixi-url-bearer-token:
14-
description:Bearer tokento usefor authenticationwhendownloadingpixi froma URL.
13+
pixi-url-headers:
14+
description:Headersto use whenfetching thepixibinaryfrom`pixi-url`. Should be a JSON string.
1515
log-level:
1616
description:|
1717
Log level for the pixi CLI.

‎dist/index.js‎

Lines changed: 6 additions & 7 deletions
Some generated files are not rendered by default. Learn more aboutcustomizing how changed files appear on GitHub.

‎dist/post.js‎

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more aboutcustomizing 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.8.13",
3+
"version":"0.8.14",
44
"private":true,
55
"description":"Action to set up the pixi package manager.",
66
"scripts": {

‎src/main.ts‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,13 @@ import { activateEnvironment } from './activate'
1212

1313
constdownloadPixi=(source:PixiSource)=>{
1414
consturl=renderPixiUrl(source.urlTemplate,source.version)
15-
constauth='bearerToken'insource&&source.bearerToken ?`Bearer${source.bearerToken}` :''
1615
returncore.group('Downloading Pixi',()=>{
1716
core.debug('Installing pixi')
1817
core.debug(`Downloading pixi from${url}`)
19-
core.debug(`UsingBearer auth:${auth ?'yes' :'no'}`)
18+
core.debug(`Usingheaders:${JSON.stringify(source.headers)}`)
2019
returnfs
2120
.mkdir(path.dirname(options.pixiBinPath),{recursive:true})
22-
.then(()=>downloadTool(url,options.pixiBinPath,auth))
21+
.then(()=>downloadTool(url,options.pixiBinPath,undefined,source.headers))
2322
.then((_downloadPath)=>fs.chmod(options.pixiBinPath,0o755))
2423
.then(()=>{
2524
core.info(`Pixi installed to${options.pixiBinPath}`)

‎src/options.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import { DEFAULT_PIXI_URL_TEMPLATE } from './util'
1212
typeInputs=Readonly<{
1313
pixiVersion?:string
1414
pixiUrl?:string
15-
pixiUrlBearerToken?:string
15+
pixiUrlHeaders?:NodeJS.Dict<string>
1616
logLevel?:LogLevel
1717
manifestPath?:string
1818
runInstall?:boolean
@@ -37,7 +37,7 @@ type Inputs = Readonly<{
3737

3838
exportinterfacePixiSource{
3939
urlTemplate:string
40-
bearerToken?:string
40+
headers?:NodeJS.Dict<string>
4141
version:string
4242
}
4343

@@ -148,8 +148,8 @@ const parseOrUndefinedList = <T>(key: string, schema: z.ZodSchema<T>): T[] | und
148148
}
149149

150150
constvalidateInputs=(inputs:Inputs):void=>{
151-
if(inputs.pixiUrlBearerToken&&!inputs.pixiUrl){
152-
thrownewError('You need to specify pixi-url when using pixi-url-bearer-token')
151+
if(inputs.pixiUrlHeaders&&!inputs.pixiUrl){
152+
thrownewError('You need to specify pixi-url when using pixi-url-headers')
153153
}
154154
if(inputs.cacheKey!==undefined&&inputs.cache===false){
155155
thrownewError('Cannot specify cache key without caching')
@@ -240,7 +240,7 @@ const inferOptions = (inputs: Inputs): Options => {
240240
construnInstall=inputs.runInstall??true
241241
constpixiSource:PixiSource={
242242
urlTemplate:inputs.pixiUrl??DEFAULT_PIXI_URL_TEMPLATE,
243-
bearerToken:inputs.pixiUrlBearerToken,
243+
headers:inputs.pixiUrlHeaders,
244244
version:inputs.pixiVersion??'latest'
245245
}
246246

@@ -358,7 +358,7 @@ const getOptions = () => {
358358
'pixi-version must either be `latest` or a version string matching `vX.Y.Z`.'
359359
),
360360
pixiUrl:parseOrUndefined('pixi-url',z.string()),
361-
pixiUrlBearerToken:parseOrUndefined('pixi-url-bearer-token',z.string()),
361+
pixiUrlHeaders:parseOrUndefinedJSON('pixi-url-headers',z.record(z.string(),z.string())),
362362
logLevel:parseOrUndefined(
363363
'log-level',
364364
logLevelSchema,

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp