Skip to content
This repository was archived by the owner on Feb 11, 2025. It is now read-only.

Commit fde2791

Browse files
bdebylbdebyl
authored
Merge pull request #213 from meltwater/1-4-0_stage
1-4-0_stage fixed the README and set the CHANGELOG for v1.4.0
2 parents 3574624 + bb2e68b commit fde2791

File tree

2 files changed

+120
-2
lines changed

2 files changed

+120
-2
lines changed

‎CHANGELOG.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
99

1010
### Added
1111

12+
### Changed
13+
14+
### Removed
15+
16+
## [1.3.0] - 2022-04-05
17+
18+
### Added
19+
1220
- [#209](https://github.com/meltwater/drone-cache/pull/209) Added double star directory searching in mounts (e.g. `path/**/subdir`)
1321
- [#198](https://github.com/meltwater/drone-cache/pull/198) Add `hashFiles` template function to generate the SHA256 hash of multiple files
1422

‎README.md‎

Lines changed: 112 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,99 @@ steps:
108108

109109
### Using executable (with CLI args)
110110

111-
[embedmd]:# (tmp/help.txt)
112111
```txt
112+
NAME:
113+
Drone cache plugin - Drone cache plugin
114+
115+
USAGE:
116+
drone-cache [global options] command [command options] [arguments...]
117+
118+
VERSION:
119+
v1.4.0
120+
121+
COMMANDS:
122+
help, h Shows a list of commands or help for one command
123+
124+
GLOBAL OPTIONS:
125+
--access-key value AWS access key [$PLUGIN_ACCESS_KEY, $AWS_ACCESS_KEY_ID, $CACHE_AWS_ACCESS_KEY_ID]
126+
--acl value upload files with acl (private, public-read, ...) (default: "private") [$PLUGIN_ACL, $AWS_ACL]
127+
--archive-format value archive format to use to store the cache directories (tar, gzip, zstd) (default: "tar") [$PLUGIN_ARCHIVE_FORMAT]
128+
--azure.account-key value Azure Blob Storage Account Key [$PLUGIN_ACCOUNT_KEY, $AZURE_ACCOUNT_KEY]
129+
--azure.account-name value Azure Blob Storage Account Name [$PLUGIN_ACCOUNT_NAME, $AZURE_ACCOUNT_NAME]
130+
--azure.blob-container-name value Azure Blob Storage container name [$PLUGIN_CONTAINER, $AZURE_CONTAINER_NAME]
131+
--azure.blob-max-retry-requets value Azure Blob Storage Max Retry Requests (default: 4) [$AZURE_BLOB_MAX_RETRY_REQUESTS]
132+
--azure.blob-storage-url value Azure Blob Storage URL (default: "blob.core.windows.net") [$AZURE_BLOB_STORAGE_URL]
133+
--backend value cache backend to use in plugin (s3, filesystem, sftp, azure, gcs) (default: "s3") [$PLUGIN_BACKEND]
134+
--backend.operation-timeout value timeout value to use for each storage operations (default: 3m0s) [$PLUGIN_BACKEND_OPERATION_TIMEOUT, $BACKEND_OPERATION_TIMEOUT]
135+
--bucket value AWS bucket name [$PLUGIN_BUCKET, $S3_BUCKET, $GCS_BUCKET]
136+
--build.created value build created (default: 0) [$DRONE_BUILD_CREATED]
137+
--build.deploy value build deployment target [$DRONE_DEPLOY_TO]
138+
--build.event value build event (default: "push") [$DRONE_BUILD_EVENT]
139+
--build.finished value build finished (default: 0) [$DRONE_BUILD_FINISHED]
140+
--build.link value build link [$DRONE_BUILD_LINK]
141+
--build.number value build number (default: 0) [$DRONE_BUILD_NUMBER]
142+
--build.started value build started (default: 0) [$DRONE_BUILD_STARTED]
143+
--build.status value build status (default: "success") [$DRONE_BUILD_STATUS]
144+
--cache-key value cache key to use for the cache directories [$PLUGIN_CACHE_KEY]
145+
--commit.author.avatar value git author avatar [$DRONE_COMMIT_AUTHOR_AVATAR]
146+
--commit.author.email value git author email [$DRONE_COMMIT_AUTHOR_EMAIL]
147+
--commit.author.name value git author name [$DRONE_COMMIT_AUTHOR]
148+
--commit.branch value git commit branch (default: "master") [$DRONE_COMMIT_BRANCH]
149+
--commit.link value git commit link [$DRONE_COMMIT_LINK]
150+
--commit.message value git commit message [$DRONE_COMMIT_MESSAGE]
151+
--commit.ref value git commit ref (default: "refs/heads/master") [$DRONE_COMMIT_REF]
152+
--commit.sha value git commit sha [$DRONE_COMMIT_SHA]
153+
--compression-level value compression level to use for gzip/zstd compression when archive-format specified as gzip/zstd
154+
(check https://godoc.org/compress/flate#pkg-constants for available options for gzip
155+
and https://pkg.go.dev/github.com/klauspost/compress/zstd#EncoderLevelFromZstd for zstd) (default: -1) [$PLUGIN_COMPRESSION_LEVEL]
156+
--debug debug (default: false) [$PLUGIN_DEBUG, $DEBUG]
157+
--encryption value server-side encryption algorithm, defaults to none. (AES256, aws:kms) [$PLUGIN_ENCRYPTION, $AWS_ENCRYPTION]
158+
--endpoint value endpoint for the s3/cloud storage connection [$PLUGIN_ENDPOINT, $S3_ENDPOINT, $GCS_ENDPOINT]
159+
--filesystem.cache-root value local filesystem root directory for the filesystem cache (default: "/tmp/cache") [$PLUGIN_FILESYSTEM_CACHE_ROOT, $FILESYSTEM_CACHE_ROOT]
160+
--gcs.acl value upload files with acl (private, public-read, ...) (default: "private") [$PLUGIN_GCS_ACL, $GCS_ACL]
161+
--gcs.api-key value Google service account API key [$PLUGIN_API_KEY, $GCP_API_KEY]
162+
--gcs.encryption-key value server-side encryption key, must be a 32-byte AES-256 key, defaults to none
163+
(See https://cloud.google.com/storage/docs/encryption for details.) [$PLUGIN_GCS_ENCRYPTION_KEY, $GCS_ENCRYPTION_KEY]
164+
--gcs.json-key value Google service account JSON key [$PLUGIN_JSON_KEY, $GCS_CACHE_JSON_KEY]
165+
--help, -h show help (default: false)
166+
--local-root value local root directory to base given mount paths (default pwd [present working directory]) [$PLUGIN_LOCAL_ROOT]
167+
--log.format value log format to use. ('logfmt', 'json') (default: "logfmt") [$PLUGIN_LOG_FORMAT, $LOG_FORMAT]
168+
--log.level value log filtering level. ('error', 'warn', 'info', 'debug') (default: "info") [$PLUGIN_LOG_LEVEL, $LOG_LEVEL]
169+
--mount value cache directories, an array of folders to cache (accepts multiple inputs) [$PLUGIN_MOUNT]
170+
--override override even if cache key already exists in backend (default: true) [$PLUGIN_OVERRIDE]
171+
--path-style AWS path style to use for bucket paths. (true for minio, false for aws) (default: false) [$PLUGIN_PATH_STYLE, $AWS_PLUGIN_PATH_STYLE]
172+
--prev.build.number value previous build number (default: 0) [$DRONE_PREV_BUILD_NUMBER]
173+
--prev.build.status value previous build status [$DRONE_PREV_BUILD_STATUS]
174+
--prev.commit.sha value previous build sha [$DRONE_PREV_COMMIT_SHA]
175+
--rebuild rebuild the cache directories (default: false) [$PLUGIN_REBUILD]
176+
--region value AWS bucket region. (us-east-1, eu-west-1, ...) [$PLUGIN_REGION, $S3_REGION]
177+
--remote-root value remote root directory to contain all the cache files created (default repo.name) [$PLUGIN_REMOTE_ROOT]
178+
--remote.url value git remote url [$DRONE_REMOTE_URL]
179+
--repo.avatar value repository avatar [$DRONE_REPO_AVATAR]
180+
--repo.branch value repository default branch [$DRONE_REPO_BRANCH]
181+
--repo.fullname value repository full name [$DRONE_REPO]
182+
--repo.link value repository link [$DRONE_REPO_LINK]
183+
--repo.name value repository name [$DRONE_REPO_NAME]
184+
--repo.namespace value repository namespace [$DRONE_REPO_NAMESPACE]
185+
--repo.owner value repository owner (for Drone version < 1.0) [$DRONE_REPO_OWNER]
186+
--repo.private repository is private (default: false) [$DRONE_REPO_PRIVATE]
187+
--repo.trusted repository is trusted (default: false) [$DRONE_REPO_TRUSTED]
188+
--restore restore the cache directories (default: false) [$PLUGIN_RESTORE]
189+
--role-arn value AWS IAM role ARN to assume [$PLUGIN_ASSUME_ROLE_ARN, $AWS_ASSUME_ROLE_ARN]
190+
--s3-bucket-public value Set to use anonymous credentials with public S3 bucket [$PLUGIN_S3_BUCKET_PUBLIC, $S3_BUCKET_PUBLIC]
191+
--secret-key value AWS secret key [$PLUGIN_SECRET_KEY, $AWS_SECRET_ACCESS_KEY, $CACHE_AWS_SECRET_ACCESS_KEY]
192+
--sftp.auth-method value sftp auth method, defaults to none. (PASSWORD, PUBLIC_KEY_FILE) [$SFTP_AUTH_METHOD]
193+
--sftp.cache-root value sftp root directory [$SFTP_CACHE_ROOT]
194+
--sftp.host value sftp host [$SFTP_HOST]
195+
--sftp.password value sftp password [$PLUGIN_PASSWORD, $SFTP_PASSWORD]
196+
--sftp.port value sftp port [$SFTP_PORT]
197+
--sftp.public-key-file value sftp public key file path [$PLUGIN_PUBLIC_KEY_FILE, $SFTP_PUBLIC_KEY_FILE]
198+
--sftp.username value sftp username [$PLUGIN_USERNAME, $SFTP_USERNAME]
199+
--skip-symlinks skip symbolic links in archive (default: false) [$PLUGIN_SKIP_SYMLINKS, $SKIP_SYMLINKS]
200+
--sts-endpoint value Custom STS endpoint for IAM role assumption [$PLUGIN_STS_ENDPOINT, $AWS_STS_ENDPOINT]
201+
--version, -v print the version (default: false)
202+
--yaml.signed build yaml is signed (default: false) [$DRONE_YAML_SIGNED]
203+
--yaml.verified build yaml is verified (default: false) [$DRONE_YAML_VERIFIED]
113204
```
114205

115206
### Using Docker (with Environment variables)
@@ -131,8 +222,27 @@ $ docker run --rm \
131222

132223
## Development
133224

134-
[embedmd]:# (tmp/make_help.txt)
135225
```txt
226+
Usage:
227+
make <target>
228+
229+
Targets:
230+
setup Setups dev environment
231+
drone-cache Runs drone-cache target
232+
clean Cleans build resourcess
233+
docs Generates docs
234+
generate Generate documentation, website and yaml files,
235+
vendor Updates vendored copy of dependencies
236+
compress Creates compressed binary
237+
container Builds drone-cache docker image with latest tag
238+
container-push Pushes latest $(CONTAINER_REPO) image to repository
239+
test Runs tests
240+
test-integration Runs integration tests
241+
test-unit Runs unit tests
242+
lint Runs golangci-lint analysis
243+
fix Runs golangci-lint fix
244+
format Runs gofmt
245+
help Shows this help message
136246
```
137247

138248
## Releases

0 commit comments

Comments
 (0)