Create Artifact
- 14 May 2021
- 1 Minute to read
-
Print
-
DarkLight
-
PDF
Create Artifact
- Updated on 14 May 2021
- 1 Minute to read
-
Print
-
DarkLight
-
PDF
This is generated from the built in components of BuildMaster 7.0.0, and may be different than what you have installed (especially if you have extensions); go to [User Icon] -> Documentation within your BuildMaster instance to see exactly what operations are available.
Create Artifact
Collects all of the files in a directory, compresses them in a zip file, and saves it to the artifact library.
Script usage:
Create-Artifact( Name: <text>, [From: <text>], [Include: <@(text)>], [Exclude: <@(text)>], [Deployable: <text>], [Verbose: <true/false>], [IgnoreEmptyArtifact: <true/false>], [Overwrite: <true/false>], [UseLegacyStoragePath: <true/false>], [IncludeSystemFiles: <true/false>], [IncludeHiddenFiles: <true/false>] );
This operation may be prefixed with Core::
, although this is a built-in namespace and isn't really necessary.
Arguments:
Name | Format | Script Usage | Usage Notes |
---|---|---|---|
☆ Artifact name (default) | text | Name | This argument is required. |
From directory | text | From | |
Include files | @(text) | Include | See KB#1119 to learn more about masking syntax. |
Exclude files | @(text) | Exclude | See KB#1119 to learn more about masking syntax. |
Deployable name | text | Deployable | Associates the created artifact with a deployable in the application; this defaults the current deployable in context. |
Verbose logging | true/false | Verbose | Using this will log every file within the artifact along with all activity that occurs during the creation of the artifact. This is great for auditing or debug purposes, but it wiill take up additional log space |
Ignore empty artifact | true/false | IgnoreEmptyArtifact | Checking this box will configure the Ignore Empty Artift setting, which, when checked, will ignore empty artifacts |
Overwrite | true/false | Overwrite | This will overwrite existing artifacts. Re-running a plan execution will fail if the artifacts are found. Set this to true to bypass this default behavior |
Use legacy storage path | true/false | UseLegacyStoragePath | See KB#1133 for information about legacy paths. |
Include system files | true/false | IncludeSystemFiles | By default system files are excluded. Set this to true if you need to include all system files |
Include hidden files | true/false | IncludeHiddenFiles | By default hidden files are excluded. Set this to true if you need to include all files or are unsure if there are hidden files that you may need |
Note: When a deployable name is specified, the created artifact will be associated with that deployable; this is particularly useful when using imported deployables, or if you need to use the same artifact name or multiple deployables.
Was this article helpful?