README.md

Artifact Bookend

sd.cd bookend for uploading artifacts

Usage

npm install screwdriver-artifact-bookend

Functionality

Store all the artifacts saved in the Artifacts Directory to the build folder in the Store, so we can make sure they're not all erased when the build is complete. This bookend currently acts only as a teardown plugin. All artifacts files/folders are written to Store on teardown.

If $SD_ZIP_ARTIFACTS is set to true, it compresses all artifacts under $SD_ARTIFACTS_DIR into a zip file and uploads the zip file to the store.

This is a default plugin that is set in the default.yaml (https://github.com/screwdriver-cd/screwdriver/blob/master/config/default.yaml) under the bookends section.

For example, if $SD_ARTIFACTS_DIR is set as /sd/workspace/artifacts and the user creates within that directory:

/sd/workspace/artifacts
--first_dir
----first_file.txt
----second_file.txt
--second_dir
----third_file.txt
----fourth_file.txt
--fifth_file.txt

Then in Store:

https://{store-uri}/logs.screwdriver.cd/builds/<BUILD_ID>-ARTIFACTS
--first_dir
----first_file.txt
----second_file.txt
--second_dir
----third_file.txt
----fourth_file.txt
--fifth_file.txt

Uploading

Testing

npm test

License

Code licensed under the BSD 3-Clause license. See LICENSE file for terms.