Promote a Release Bundle (v2) to a Target Environment

JFrog Artifactory Documentation

Products
JFrog Artifactory
Content Type
User Guide
ft:sourceType
Paligo

A promotion operation represents one step as the release advances through the stages of its lifecycle. Promoting a Release Bundle version copies the contents of the Release Bundle to a defined set of target repositories in a defined environment. For example, you can promote to a Staging environment or to Production.

Note

The target repositories must be local, Federated, or virtual, provided the virtual repository contains at least one local repository in the relevant environment (or in no environment).

When a Release Bundle is promoted, evidence in the form of a signed and locked file is attached to the Release Bundle that provides a record of the promotion (when, where, and by whom). This evidence provides full traceability and attests to the immutability of the Release Bundle. Each promotion adds another layer of signed evidence that safeguards the immutability of the Release Bundle.

To promote a Release Bundle v2 to a target environment:

  1. In the Application module, select Artifactory > Release Lifecycle. The Release Lifecycle dashboard is displayed.

  2. Click the name of the relevant Release Bundle to open the kanban board.

  3. Do one of the following:

    • Click the kanban card for the relevant Release Bundle version to open the timeline view. Select Actions > Promote.

      Dashboard_promote-RB_menu.png

      Or,

    • Drag-and-drop the card representing the relevant Release Bundle version to the desired environment.

      Dashboard_promote-by-dragndrop.png

    Note

    It is possible to promote the Release Bundle version to any environment in either direction on the kanban board.

  4. In the Promotion Environment tab, do the following:

    • (optional) Change the signing key, if desired.

    • Choose the promotion type: Copy Artifacts or Move Artifacts

      If you choose Move Artifacts, the artifacts contained in the Release Bundle are deleted from the repositories in the source environment during promotion.

    • Verify the selected target environment.

    move-promotion-dbox.png
  5. Click Next.

  6. In the Target Repositories tab, review the list of target repositories for each package type. To modify the list, open the relevant dropdown list and clear the checkmark next to each repository to exclude it from the promotion.

    Dashboard_promotion_Target-Repo-tab2.png

    Note

    There must be at least one repository defined for each package type.

  7. Click Promote.

    Note

    If any artifact in the promotion has a different checksum than the same artifact in the target environment, the promotion stops, and an error message is displayed.

    Note

    You cannot modify or delete a file that belongs to a promoted Release Bundle. You must first delete the promotion or delete the Release Bundle version altogether before the files can be modified or deleted. This restriction protects the immutability of the Release Bundle.

    Warning

    When JFrog Xray is used to scan Release Bundles for potential vulnerabilities and license violations, Xray will block promotion if the Release Bundle violates a Policy that has a blocking action defined. For more information, see Scan Release Bundles (v2) with Xray.

    Warning

    Make sure the signing key is valid. The operation will fail if the key has expired.

Promoting a Release Bundle v2 using the REST API

To promote a Release Bundle v2 version from one environment to another, use the Promote Release Bundle v2 Version REST API.EnvironmentsPromote Release Bundle v2 Version