Skip to content

Commit

Permalink
add note to README
Browse files Browse the repository at this point in the history
  • Loading branch information
cscanlin-kwh committed Apr 29, 2023
1 parent d92ee55 commit 0c5a0a0
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ version numbers.

* `disable_multipart`: *Optional.* Disable Multipart Upload. useful for S3 compatible providers that do not support multipart upload.

* `order_by`: *default: 'semver'*:
- `'semver'`: The pattern in the regex capture group will be parsed and sorted as a semantic version
- `'string'`: The pattern in the regex capture group will be stored raw and sorted using string sorting rules

### File Names

One of the following two options must be specified:
Expand All @@ -63,7 +67,7 @@ One of the following two options must be specified:
capture group must be specified, with parentheses.

The version extracted from this pattern is used to version the resource.
Semantic versions, or just numbers, are supported. Accordingly, full regular
By default, semantic versions, or just numbers, are supported. If the `order_by: 'string'` option is given, the extracted version will be compared against the other versions as plain strings. Accordingly, full regular
expressions are supported, to specify the capture groups.

The full `regexp` will be matched against the S3 objects as if it was anchored
Expand Down

0 comments on commit 0c5a0a0

Please sign in to comment.