Versioning an Unlocked Package

Updated 5 months ago by Copado Solutions

Generate a New Version

A package version is a fixed snapshot of the package contents and related metadata. The package version lets you manage changes and track what’s different each time you release or deploy a specific set of changes.

When clicking for the first time on Generate New Version in the Unlocked Artifact record, the following warning will be displayed “You need to create a package first to be able to generate beta version”.

In order to successfully generate a New Version follow the steps below:

  1. Still while viewing the Generate New Version screen, click on Generate Package to generate the Unlocked Package for the first time.
  2. Once the package is generated successfully, click again on Generate New Version to create a new version of the package.
  3. In the new screen, define the new version details:


    1. Previous Release Version: read only field to inform previous release version of the artifact.
    2. New Version Name: new name for the version of the package.
    3. New Release Version: The version number of the package version. Must be in major.minor.patch.build format. (ex: 1.0.0.0)
    4. New Version Description: package description (e.g. summary of features)
    5. Installation Key: an option parameter to have an installation key for a key-protected package. If empty the installationkeybypass parameter will be automatically set to true.
  4. Click on Generate Beta version to create a new version of the package that can can installed.
Note you can’t install beta packages in a production org. This is a safeguard to make sure the package version you release is production ready. When you know that a version is ready for the world, you can promote the package version to released.

Promote Beta version to Released version

For the package to be ready to be installed in Production Orgs, is needed to promote it to Released Version.

The Latest Package Version field on the Unlocked Package record is auto-populated upon new version creation.

Notice that there is also a related list of all the package versions.

  1. To begin with, locate the Artifact Version record in Beta and open the record.
  2. Click on Promote Beta to Release.
  3. You will see a screen with a short summary of the definition file.
  4. Click on Promote Package.
  5. After promoting the package, the Artifact Version record will be automatically flagged as Is Released.


How did we do?