Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joseluisq/drone-archive
Drone plugin that provides Tar/Gzip and Zip archiving/compression with optional checksum computation.
https://github.com/joseluisq/drone-archive
archiving compression drone-archive drone-plugin gzip tar zip
Last synced: 28 days ago
JSON representation
Drone plugin that provides Tar/Gzip and Zip archiving/compression with optional checksum computation.
- Host: GitHub
- URL: https://github.com/joseluisq/drone-archive
- Owner: joseluisq
- License: apache-2.0
- Created: 2020-11-29T15:40:43.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2020-12-13T23:52:20.000Z (almost 4 years ago)
- Last Synced: 2024-05-23T00:09:52.963Z (6 months ago)
- Topics: archiving, compression, drone-archive, drone-plugin, gzip, tar, zip
- Language: Go
- Homepage:
- Size: 31.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Drone Archive Plugin
[](https://travis-ci.com/joseluisq/drone-archive) [](https://codecov.io/gh/joseluisq/drone-archive) [](https://goreportcard.com/report/github.com/joseluisq/drone-archive) [](https://pkg.go.dev/github.com/joseluisq/drone-archive) [](https://hub.docker.com/r/joseluisq/drone-archive/) [](https://hub.docker.com/r/joseluisq/drone-archive/) [](https://hub.docker.com/r/joseluisq/drone-archive/)
> [Drone](https://drone.io/) plugin that provides Tar/Gzip and Zip archiving with optional checksum computation.
## Usage
```yml
---
kind: pipeline
type: docker
name: production
platform:
os: linux
arch: amd64
steps:
- name: archive
image: joseluisq/drone-archive
settings:
format: tar
src_base_path: ./my-base-path
src: ./release/myprogram
dest: ./myprogram.tar.gz
checksum: true
checksum_algo: sha256
checksum_dest: myprogram.CHECKSUM.tar.gz.txt
```
## API
```sh
$ drone-archive --help
# NAME: archive plugin [OPTIONS] COMMAND
#
# Archive a file or directory using Tar/Gzip or Zip with optional checksum computation.
#
# OPTIONS:
# -b --src-base-path Source base path directory which will be skipped for each archive file header. [env: PLUGIN_SRC_BASE_PATH]
# -s --src File or directory to archive and compress. [env: PLUGIN_SRC]
# -d --dest File destination path to save the archived/compressed file. [env: PLUGIN_DEST]
# -f --format Define a `tar` and `zip` archiving format with compression. Tar format uses Gzip compression. [default: tar] [env: PLUGIN_FORMAT]
# -c --checksum Enable checksum file computation. [default: false] [env: PLUGIN_CHECKSUM]
# -a --checksum-algo Define the checksum `md5`, `sha1`, `sha256` or `sha512` algorithm. [default: sha256] [env: PLUGIN_CHECKSUM_ALGO]
# -e --checksum-dest File destination path of the checksum. [env: PLUGIN_CHECKSUM_DEST]
# -h --help Prints help information
# -v --version Prints version information
```
## Development
### Test
```sh
make test
```
### Build
Build the binaries and Docker image.
```sh
make build image.build
```
### Run
Run Docker images examples.
```sh
make image.tar
# or
make image.zip
```
## Contributions
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in current work by you, as defined in the Apache-2.0 license, shall be dual licensed as described below, without any additional terms or conditions.
Feel free to send some [Pull request](https://github.com/joseluisq/drone-archive/pulls) or [issue](https://github.com/joseluisq/drone-archive/issues).
## License
This work is primarily distributed under the terms of both the [MIT license](LICENSE-MIT) and the [Apache License (Version 2.0)](LICENSE-APACHE).
© 2020-present [Jose Quintana](https://git.io/joseluisq)