Artifacts

Updated 1 week ago by David Pinett

Artifact

With Artifacts you can move to a  modular approach for Salesforce development process. An Artifact is a logical set of metadata that represents a subset of an org.

An artifact can be tested independently from other components in your org and should be able to be released independently as well. 

The metadata components within an artifact can only live in one artifact at a time.  All source for your artifacts is stored in your artifact repository. Copado takes care of the handling process for you. 

You can define two types of artifacts:

  1. Git Artifact
    1. Version Control Artifact
  2. Package Artifact
    1. Salesforce Unmanaged Package


How to create a Git Artifact

After meeting DX requisites, follow these steps:

  1. Create an empty Git Repository on your Git Server and Initialize it.
    1. Tip: Use the same name for the Git Repository on your Server and on the artifact record.
  2. Create a Repository record on Copado with connection details to the previously created Repository.
  3. From Copado DX application, click New to create an Artifact record.
    1. Select the Git Artifact Record Type. 
    2. Select the Org Credential for the environment holding metadata. 
    3. Select the Repository created for the Artifact.
    4. Save.
  4. Click on Manage Metadata button
    1. From the metadata grid, select the metadata to include in the artifact.
    2. Click on save button. 

Note:

  • If you are working with Copado Releases Tags, your artifacts will be tagged accordingly.  


How to create a Package Artifact

After meeting DX requisites, follow these steps:

  1. From Copado DX application, click New to create an Artifact record.
    1. Select the Package Artifact Record Type. 
    2. Select the Org Credential for the environment holding metadata. 
    3. Save.
  2. Click on Manage Package Selection button
    1. From the grid, select the Unmanaged Package to use for the artifact.
      1. If the package is new, click "Refresh List of Packages".
    2. Click on save button. 

Note:

  • If the package has a key, you can write it on the Package Key field.


Working with Artifacts

After you have created an Artifact, you can create a Scratch Org and load the metadata, making it ready to be used as part of your User Stories.

Important: If a new component is created in the Scratch Org and is tried to be committed from a User Story, Copado will prompt you to select the Artifact in which this new component should exist.

Applying Tags to your Artifacts will require that the User Stories have a  Release record related and Version field is filled.

When the User Story is promoted and then deployed, new elements will be pushed to the Artifact repository (Tagged with the same version as the Release record, if there is no version, push will be done but without tag). Metadata Selection will be included in the Artifact record and a related Artifact Version record will be created.



How did we do?