Skip to content

Commit 1bf997c

Browse files
committed
Minor readme formatting
1 parent ce7096c commit 1bf997c

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -118,21 +118,21 @@ steps:
118118
119119
You must specify at least one of the following
120120
121-
### `upload` (string, array of strings, {from,to}, array of {from,to})
122-
123-
A glob pattern, or array of glob patterns, for files to upload as-is. Alternatively, you can specify `from` and `to` to rename the artifact before uploading.
124-
125121
### `download` (string, array of strings, {from,to}, array of {from,to[,step][,build]})
126122

127123
A glob pattern, or array of glob patterns, for files to download. Alternatively you can specify `from` and `to` to rename the artifact after downloading. If you do so, you can also specify `step` and/or `build` to override those options for that particular artifact.
128124

125+
### `upload` (string, array of strings, {from,to}, array of {from,to})
126+
127+
A glob pattern, or array of glob patterns, for files to upload as-is. Alternatively, you can specify `from` and `to` to rename the artifact before uploading.
128+
129129
## Other Configuration
130130

131-
### `build` (`download`-only, string)
131+
### `build` (string, download only)
132132

133133
The build UUID to download all artifacts from. Note that you can override it for specific artifacts when using the verbose format of the `download` element.
134134

135-
### `compressed` (optional, string)
135+
### `compressed` (string)
136136

137137
⚠️ Limitations:
138138
* filename needs to end with `.zip` or `.tgz` and that will determine the compression executable to use
@@ -161,11 +161,11 @@ steps:
161161
compressed: logs.tgz
162162
```
163163

164-
### `ignore-missing` (optional, boolean)
164+
### `ignore-missing` (boolean)
165165

166166
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.
167167

168-
### `skip-on-status` (optional, integer or array of integers, uploads only)
168+
### `skip-on-status` (integer or array of integers, upload only)
169169

170170
You can set this to the exit codes or array of exit codes of the command step (as defined by the `BUILDKITE_COMMAND_EXIT_STATUS` variable) that will cause the plugin to avoid trying to upload artifacts.
171171

@@ -195,7 +195,7 @@ steps:
195195
- 5
196196
```
197197

198-
### `step` (`download`-only, string)
198+
### `step` (string, download only)
199199

200200
The job UUID or name to download all artifacts from. Note that you can override it for specific artifacts when using the verbose format of the `download` element.
201201

0 commit comments

Comments
 (0)