https://github.com/screwdriver-cd/artifact-bookend
sd.cd bookend for uploading artifacts
https://github.com/screwdriver-cd/artifact-bookend
Last synced: 11 months ago
JSON representation
sd.cd bookend for uploading artifacts
- Host: GitHub
- URL: https://github.com/screwdriver-cd/artifact-bookend
- Owner: screwdriver-cd
- License: other
- Created: 2017-02-16T01:27:59.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-02-20T17:45:17.000Z (over 1 year ago)
- Last Synced: 2025-07-06T13:50:22.518Z (11 months ago)
- Language: JavaScript
- Homepage: https://cd.screwdriver.cd/pipelines/73
- Size: 61.5 KB
- Stars: 0
- Watchers: 20
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Artifact Bookend
[![Version][npm-image]][npm-url] ![Downloads][downloads-image] [![Build Status][status-image]][status-url] [![Open Issues][issues-image]][issues-url] ![License][license-image]
> sd.cd bookend for uploading artifacts
## Usage
```bash
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/-ARTIFACTS
--first_dir
----first_file.txt
----second_file.txt
--second_dir
----third_file.txt
----fourth_file.txt
--fifth_file.txt
```
## Uploading
## Testing
```bash
npm test
```
## License
Code licensed under the BSD 3-Clause license. See LICENSE file for terms.
[npm-image]: https://img.shields.io/npm/v/screwdriver-artifact-bookend.svg
[npm-url]: https://npmjs.org/package/screwdriver-artifact-bookend
[downloads-image]: https://img.shields.io/npm/dt/screwdriver-artifact-bookend.svg
[license-image]: https://img.shields.io/npm/l/screwdriver-artifact-bookend.svg
[issues-image]: https://img.shields.io/github/issues/screwdriver-cd/artifact-bookend.svg
[issues-url]: https://github.com/screwdriver-cd/artifact-bookend/issues
[status-image]: https://cd.screwdriver.cd/pipelines/73/badge
[status-url]: https://cd.screwdriver.cd/pipelines/73