Artifacts
Introduction
An artifact is a file or zip generated upon the application build process during the execution of the pipeline. These artifacts are deployable entities, which includes infrastructure and apps. You can store and retrieve the artifacts during the pipeline execution in the Catalyst Stratus service.
There are two types of artifacts :
-
A single artifact file : This build file can be direcly uploaded to a bucket in Catalyst Stratus and then downloaded when required.
-
An artifact zip : This type includes configuring regular expressions to pick the relavant files, zip them and upload to a bucket in Catalyst Stratus and then download the zip when required.
You can define the required artifacts for the pipeline as key-value pairs using the artifacts key. These artifacts can be included as a part of the jobs created using steps, in the Catalyst console. You can refer to this help section to learn more artifact configuration in jobs. However they are not applicable to parallel and approval jobs.
Properties of an Artifact
Upload
| Key | Value | is Mandatory |
|---|---|---|
| upload | This key contains the configurations required for the artifact upload process. | Yes |
| type | Provide the value as either file or zip. | Yes |
| name | The name of the artifact. (file name or zip name) For example : SNAPSHOT.jar (for file type) Build.zip (for zip type) | Yes |
| file | The source path of the artifact file. For example : target/demo-0.0.1-SNAPSHOT.jar | Yes (if the artifact type is file) |
| regex | The regular expression pattern that identifies files and compresses all the matching ones. For example : - /catalyst/node_modules/**/ | Yes (if the artifact type is zip) |
| location | The location path in Stratus where the file or zip has to be uploaded.
For example :
stratus://< |
Yes |
Download
| Key | Value | is Mandatory |
|---|---|---|
| download | This key contains the configurations required for the artifact download process. | Yes |
| type | file or zip. Provide this value based on your preference. | Yes |
| name | The name of the artifact in Stratus. For example : SNAPSHOT.jar (for file type) Build.zip (for zip type) | Yes |
| file | The destination path where the file has to be downloaded. For example : /SNAPSHOT.jar. | Yes (if the artifact type is file) |
| location | The Stratus location from which the file has to be downloaded.
For example :
stratus://< |
Yes |
If the artifact type is set to zip, the zip file will be downloaded to the root directory by default.
Refer to this section for a sample YAML code snippet configured with artifacts.
Last Updated 2025-05-30 16:54:59 +0530 +0530
Yes
No
Thank you for your feedback!
Send your feedback to us