Skip to content

Commit d878de1

Browse files
committed
set put.inputs default to "detect"
Signed-off-by: Taylor Silva <dev@taydev.net>
1 parent 69da3dd commit d878de1

1 file changed

Lines changed: 19 additions & 11 deletions

File tree

docs/docs/steps/put.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -74,16 +74,21 @@ Pushes to the given [resource](../resources/index.md). Expand each section below
7474
type: mock
7575
```
7676

77-
??? info "**`version`**: `all` | `detect` | [`[identifier]`](../config-basics.md#identifier-schema)"
77+
??? info "**`version`**: `detect` | `all` | [`[identifier]`](../config-basics.md#identifier-schema)"
7878

79-
_Default `all`_. When not set, or set to `all`, all artifacts will be provided. This can result in slow performance
80-
if the prior steps in the build plan register a bunch of large artifacts before this step, so you may want to
81-
consider being explicit.
79+
_Default `detect`_.
8280

83-
If configured as a list of identifiers, only the listed artifacts will be provided to the container.
81+
When not set, or set to `detect`, the artifacts are detected based on the
82+
configured `put` step `params` by looking for all string values and using
83+
the first path segment as an identifier.
84+
85+
If set to `all`, all artifacts will be provided. This can result in slow
86+
performance if the prior steps in the build plan register a bunch of large
87+
artifacts before this step, so you may want to consider being explicit.
88+
89+
If configured as a list of identifiers, only the listed artifacts will be
90+
provided to the container.
8491

85-
If set to `detect`, the artifacts are detected based on the configured `put` step `params` by looking for all string
86-
values and using the first path segment as an identifier. (This may become the default in the future.)
8792

8893
??? example "Put Input Methods"
8994

@@ -96,14 +101,14 @@ Pushes to the given [resource](../resources/index.md). Expand each section below
96101
- get: repo-master
97102
- get: app-image
98103
- get: ci
99-
- put: all-inputs
104+
- put: detect-inputs
100105
resource: repo
101-
inputs: all # default option
106+
inputs: detect # default, will only stream the "ci" artifact
102107
params:
103108
file: ci/version.txt
104-
- put: detect-inputs
109+
- put: all-inputs
105110
resource: repo
106-
inputs: detect # will only stream the "ci" artifact
111+
inputs: all # will stream all artifacts
107112
params:
108113
file: ci/version.txt
109114
- put: explicit-inputs
@@ -172,3 +177,6 @@ Pushes to the given [resource](../resources/index.md). Expand each section below
172177
??? info "**`no_get`**: [`boolean`](../config-basics.md#boolean-schema)"
173178

174179
Skips the get step that usually follows the completion of the put step.
180+
This is useful to set if your `put` steps are at the very end of your job
181+
and no further steps would use the artifact generated by the implicit
182+
`get` step.

0 commit comments

Comments
 (0)