Skip to content

Commit 7c1d3b6

Browse files
committed
Reordered options and clarified some things in README
1 parent b09c8fb commit 7c1d3b6

1 file changed

Lines changed: 15 additions & 11 deletions

File tree

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ steps:
3131
- command: ...
3232
plugins:
3333
- artifacts#v1.9.4:
34-
upload:
34+
upload:
3535
- from: log1.log
3636
to: log2.log
3737
```
@@ -91,7 +91,7 @@ steps:
9191
- command: ...
9292
plugins:
9393
- artifacts#v1.9.4:
94-
download:
94+
download:
9595
- from: log1.log
9696
to: log2.log
9797
```
@@ -105,7 +105,7 @@ steps:
105105
- artifacts#v1.9.4:
106106
step: UUID-DEFAULT
107107
build: UUID-DEFAULT-2
108-
download:
108+
download:
109109
- from: log1.log
110110
to: log2.log
111111
step: UUID-1
@@ -114,23 +114,23 @@ steps:
114114
build: UUID-2
115115
```
116116
117-
## Configuration
117+
## Mandatory Configuration
118+
119+
You must specify at least one of the following
118120
119121
### `upload` (string, array of strings, {from,to}, array of {from,to})
120122

121-
A glob pattern, or array of glob patterns, for files to upload.
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.
122124

123125
### `download` (string, array of strings, {from,to}, array of {from,to[,step][,build]})
124126

125-
A glob pattern, or array of glob patterns, for files to download.
126-
127-
### `step` (optional, string)
127+
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.
128128

129-
The job UUID or name to download the artifacts from unless specified otherwise in the `download` array specification.
129+
## Other Configuration
130130

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

133-
The build UUID to download the artifact from unless specificed otherwise in the `download` array specification.
133+
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

135135
### `compressed` (optional, string)
136136

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

198+
### `step` (`download`-only, string)
199+
200+
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.
201+
198202
## Developing
199203

200204
To run testing, shellchecks and plugin linting use use `bk run` with the [Buildkite CLI](https://github.com/buildkite/cli).

0 commit comments

Comments
 (0)