Skip to content

Commit 6d6b2ba

Browse files
committed
Update plugin spec options and its documentation
1 parent 5301874 commit 6d6b2ba

2 files changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,11 @@ Setting the `BUILDKITE_PLUGIN_S3_CACHE_ONLY_SHOW_ERRORS` environment variable wi
6969

7070
Allows for the cached file/folder to be saved/restored as a single file. You will need to make sure to use the same compression when saving and restoring or it will cause a cache miss.
7171

72-
Assuming the underlying executables are available, the allowed values are:
72+
The value `none` is equivalent to not specifying a compression. Any other value (`X`) will assume that a wrapper script exists to handle both compression and decompression with the following protocol:
73+
* `X_wrapper compress SOURCE TARGET`: compress the file/folder `SOURCE` into the `TARGET` file
74+
* `X_wrapper decompress SOURCE TARGET`: decompress the artifact `SOURCE` into `TARGET` destination
75+
76+
The plugin includes wrappers to provide both examples and backwards-compatibility:
7377
* `tgz`: `tar` with gzip compression
7478
* `zip`: `(un)zip` compression
7579

plugin.yml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,6 @@ configuration:
1717
type: string
1818
compression:
1919
type: string
20-
enum:
21-
- zip
22-
- tar
23-
- tgz
2420
force:
2521
type: boolean
2622
keep-compressed-artifacts:

0 commit comments

Comments
 (0)