Add more info regarding globs

This commit is contained in:
Andres Almiray
2021-04-29 00:41:23 +02:00
parent 35894fb85f
commit 77f0e96c1b

View File

@@ -1,10 +1,13 @@
= Artifacts
= Artifacts & Globs
Artifacts are at the heart of a release; they define files that may be:
* added to a Git xref:configuration:release/index.adoc[release].
* prepared, packaged, and uploaded using a xref:configuration:packagers/index.adoc[packager].
Artifacts refer to a specific file as they have a single `path` property. Globs on the other hand refer to a collection
of files.
== Properties
Artifacts have the following properties:
@@ -23,6 +26,18 @@ and xref:configuration:packagers/index.adoc[packagers] require that artifacts de
include::configuration:partial$platform.adoc[]
Globs have the following properties:
* `directory`. Defines the starting point when searching for files.
* `include`. Defines a file name pattern. Matches will be included in the final collection.
* `exclude`. Defines a file name pattern. Matches will be excluded from the final collection.
* `recursive`. Whether to search recursively or not.
IMPORTANT: The values of `directory`, `include`, and `exclude` are optional but at least one of them has to be specified.
Both `include` and `exclude` accept glob or regex patterns by using `glob:` and `regex:` prefixes accordingly.
If no prefix is specified then `glob:` will be used.
== Examples
*Platform*