Skip to content

Commit 182ed03

Browse files
committed
Added documentation for new options and updated plugin schema
1 parent 45df997 commit 182ed03

2 files changed

Lines changed: 18 additions & 0 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,18 @@ steps:
161161
compressed: logs.tgz
162162
```
163163

164+
### `expand-download-vars` (boolean, **unsafe**, download only)
165+
166+
When set to true, it will activate interpolation of variables in the elements of the `download` path-related configurations as well as `compressed` option if present. When turned off (the default), attempting to use variables will fail as the literal `$VARIABLE_NAME` string will be used.
167+
168+
⚠️ Important: this is considered an unsafe option as the most compatible way to achieve this is to run the strings through `eval` which could lead to arbitrary code execution or information leaking if you don't have complete control of the pipeline.
169+
170+
### `expand-upload-vars` (boolean, **unsafe**, download only)
171+
172+
When set to true, it will activate interpolation of variables in the elements of the `upload` path-related configurations as well as `compressed` option if present. When turned off (the default), attempting to use variables will fail as the literal `$VARIABLE_NAME` string will be used.
173+
174+
⚠️ Important: this is considered an unsafe option as the most compatible way to achieve this is to run the strings through `eval` which could lead to arbitrary code execution or information leaking if you don't have complete control of the pipeline.
175+
164176
### `ignore-missing` (boolean)
165177

166178
If set to `true`, it will ignore errors caused when calling `buildkite-agent artifact` to prevent failures if you expect artifacts not to be present in some situations. When using the `compressed` property, it will ignore compressing the artifacts that are not present.

plugin.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,17 @@ configuration:
5858
- type: array
5959
items:
6060
type: integer
61+
expand-download-vars:
62+
type: boolean
63+
expand-upload-vars:
64+
type: boolean
6165
oneOf:
6266
- required:
6367
- upload
6468
- required:
6569
- download
6670
dependencies:
6771
skip-on-status: [ upload ]
72+
expand-download-vars: [ download ]
73+
expand-upload-vars: [ upload ]
6874
additionalProperties: false

0 commit comments

Comments
 (0)