Skip to content

Commit baa3121

Browse files
committed
Clarify runtime variable interpolation in README
Added a note explaining that certain runtime variables like BUILDKITE_RETRY_COUNT may not expand reliably due to interpolation timing. Referenced a link to documentation on runtime variable interpolation for further info.
1 parent b6b67d6 commit baa3121

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,8 @@ When set to true, it will activate interpolation of variables in the elements of
173173

174174
⚠️ 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.
175175

176+
Note: Runtime variables like `BUILDKITE_RETRY_COUNT` may not expand reliably as Buildkite interpolates pipeline YAML at upload time, before this plugin runs. In cases such as this, consider using [Runtime variable interpolation](https://buildkite.com/docs/pipelines/configure/environment-variables#runtime-variable-interpolation)
177+
176178
### `ignore-missing` (boolean)
177179

178180
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.

0 commit comments

Comments
 (0)