Create a Release Bundle v2 in the Platform UI

You can use the platform UI to create a new Release Bundle v2 from:

In addition, you can create a new version of an existing Release Bundle.

Create a Release Bundle v2 from Builds

Use the menu on the Release Lifecycle page to create a Release Bundle v2 from one or more builds.

📘

Note

You can also create a Release Bundle v2 directly from the Builds page. For more information, see Create a Release Bundle (v2) from the Builds Table.

To create a Release Bundle v2 from a build:

  1. In the Platform module, select Artifactory > Release Lifecycle.

  2. From the Actions menu, select Create Version from Builds from the list. The New Release Bundle Version window is displayed.

    RLM-redesign_RB-actions-menu_create-from-builds.png
  3. In the Release Bundle Details tab, do the following:

    1. Enter a name for the Release Bundle. (If a Release Bundle was previously created from the selected build, its name will appear.)

    2. Enter the version number of the Release Bundle.

    3. [optional] Select a signing key. If you do not select a key, a default key (generated by Artifactory automatically) is used. See Create Signing Keys for Release Bundles (v2).

📘

Note

Naming restrictions:

  • The name is limited to 128 characters. Use the REST API or the JFrog CLI if a longer name is required.
  • The version is limited to 32 characters. Use the REST API or the JFrog CLI if a longer version is required.
  • The name and version must begin with a letter, digit, or underscore.
  • The name must consist only of letters, digits, underscores, periods, and hyphens. The version supports these characters and also supports the plus sign (+).
⚠️

Warning

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

  1. Click Next to move to the Builds Selection tab.
  2. Define the builds from which to create the Release Bundle:
    1. Select the build name and version from the lists provided.
    2. [optional] Select the Include Build Dependencies checkbox to have the Release Bundle include the dependencies associated with the build.
    3. Click Add. The select build and version appear in the selection box.
❗️

Important

Dependencies located in local, Federated, and remote repositories can be included in the Release Bundle. To include dependencies from a remote repository, you must first ensure that they exist in the remote cache. If they are not in the cache, you need to download them before creating the Release Bundle..

create_RB_from_builds_dbox.png
  1. [optional] Repeat step 5 to add additional builds to the new Release Bundle.
  2. Click Create.

Create a Release Bundle (v2) from the Builds Table

You can use the Builds table to create a Release Bundle v2 from one or more builds, as an alternative to using the Release Lifecycle UI.

The procedures are described in the following sections:

📘

Note

If the Release Bundle is created from a build associated with a project, the Release Bundle will also be associated with the project, even when working in a global context (i.e. when All Projects is selected from the project selector).

Create a Release Bundle v2 from One or More Builds

Perform the procedure below to create a Release Bundle v2 from one or more builds.

To create a Release Bundle v2 from one or more builds:

  1. In the Platform module, select Artifactory > Builds.

  2. Click Create Release Bundle.

    RBv2_Build-screen_create-rb-button.png
  3. In the Release Bundle Details tab of the New Release Bundle window, do the following:

    1. Enter a name for the Release Bundle. (If a Release Bundle was previously created from the selected build, its name will appear.)

    2. Enter the version number of the Release Bundle.

    3. Select a signing key. If you do not select a key, a default key (generated by Artifactory automatically) is used. See Create Signing Keys for Release Bundles (v2).

📘

Note

Naming restrictions:

  • The name is limited to 128 characters. Use the REST API or the JFrog CLI if a longer name is required.
  • The version is limited to 32 characters. Use the REST API or the JFrog CLI if a longer version is required.
  • The name and version must begin with a letter, digit, or underscore.
  • The name must consist only of letters, digits, underscores, periods, and hyphens. The version supports these characters and also supports the plus sign (+).
⚠️

Warning

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

  1. Click Next to move to the Builds Selection tab.

  2. Define the builds from which to create the Release Bundle:

    1. Select the name and version of the build from the lists provided.

    2. [optional] Select the Include Build Dependencies checkbox to have the Release Bundle include the dependencies associated with the build.

    3. Click Add. The selected build and version appear in the selection box.

  3. Click Create.

The Release Bundle appears:

  • On the stages board.
  • As an event in the Release Bundle version timeline .
  • In the Release Bundle column of the Builds table.
❗️

Important

Dependencies located in local, Federated, and remote repositories can be included in the Release Bundle. To include dependencies from a remote repository, you must first ensure that they exist in the remote cache. If they are not in the cache, you need to download them before creating the Release Bundle.

Create a Release Bundle v2 from a Single Build

Perform the procedure below to create a Release Bundle v2 from a single, selected build.

  1. In the Platform module, select Artifactory > Builds.

  2. Click the name of the desired build, and then select Create Release Bundle from the actions menu.

    GA_create-rb.png

Tip

Alternatively, click the name of a specific Release Bundle version and then click Create Release Bundle.

  1. In the Release Bundle Details tab of the New Release Bundle window, do the following:

    1. Enter a name for the Release Bundle. (If a Release Bundle was previously created from the selected build, its name will appear.)

    2. Enter the version number of the Release Bundle.

    3. [optional] Select a signing key. If you do not select a key, a default key (generated by Artifactory automatically) is used. See Create Signing Keys for Release Bundles (v2).

📘

Note

Naming restrictions:

  • The name is limited to 128 characters. Use the REST API or the JFrog CLI if a longer name is required.
  • The version is limited to 32 characters. Use the REST API or the JFrog CLI if a longer version is required.
  • The name and version must begin with a letter, digit, or underscore.
  • The name must consist only of letters, digits, underscores, periods, and hyphens. The version supports these characters and also supports the plus sign (+).
  1. Click Next.

  2. In the Contents tab, review the list of modules (containing artifacts and dependencies) to be included in the Release Bundle.

    GA_new-release-bundle_content-tab.png
  3. (optional) Select the Include Build Dependencies checkbox to have the Release Bundle include the dependencies associated with the build.

❗️

Important

Dependencies located in local, Federated, and remote repositories can be included in the Release Bundle. To include dependencies from a remote repository, you must first ensure that they exist in the remote cache. If they are not in the cache, you need to download them before creating the Release Bundle.

  1. Click Create. The Release Bundle appears:

    • On the stages board.
    • As an event in the Release Bundle version timeline.
    • In the Release Bundle column of the Builds table.

Create a Release Bundle (v2) from Existing Release Bundles

In addition to creating a Release Bundle v2 from builds, it is possible to create a Release Bundle from one or more existing Release Bundles. For example, this can be used when multiple development teams are working on different microservices, each of which has its own Release Bundle. When it comes time to release a new version of the entire product, the various Release Bundles for the microservices can be combined into a single Release Bundle containing the complete release.

To create a Release Bundle v2 from existing Release Bundles:

  1. In the Platform module, select Artifactory > Release Lifecycle.

  2. From the Actions menu, select Create Version from Release Bundles. The New Release Bundle Version window is displayed.

    RLM-redesign_RB-actions-menu_create-from-rbs.png
  3. In the Release Bundle Details tab, do the following:

    1. Enter a name for the Release Bundle. (If a Release Bundle was previously created from the selected build, its name will appear.)

    2. Enter the version number of the Release Bundle.

    3. [optional] Select a signing key. If you do not select a key, a default key (generated by Artifactory automatically) is used. See Create Signing Keys for Release Bundles (v2).

📘

Note

Naming restrictions:

  • The name is limited to 128 characters. Use the REST API or the JFrog CLI if a longer name is required.
  • The version is limited to 32 characters. Use the REST API or the JFrog CLI if a longer version is required.
  • The name and version must begin with a letter, digit, or underscore.
  • The name must consist only of letters, digits, underscores, periods, and hyphens. The version supports these characters and also supports the plus sign (+).
⚠️

Warning

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

  1. Click Next to move to the Bundles Selection tab.
  2. Define the Release Bundle from which to create the new Release Bundle:
    1. Select the name and version of the Release Bundle from the list provided.
    2. Click Add. The selected Release Bundle and version appear in the selection box.
  3. [optional] Repeat step 5 to add additional Release Bundles to the new Release Bundle.
  4. Click Create.

Create a New Version of an Existing Release Bundle

You can create a new version of an existing Release Bundle v2.

To create a new version of an existing Release Bundle v2:

  1. In the Platform module, select Artifactory > Release Lifecycle. The Versions tab is displayed.

  2. Click the name of the relevant Release Bundle.

  3. From the Actions menu, select one of the following:

    • Create Version from Release Bundles
    • Create Version from Builds

    The New Release Bundle Version window is displayed with the name of the current Release Bundle.

  4. Enter a new version number in the field provided.

⚠️

Warning

Version number restrictions:

  • The version is limited to 32 characters.
  • The version must begin with a letter, digit, or underscore.
  • The version must consist only of letters, digits, underscores, periods, hyphens, and the plus sign (+).
  1. Select a signing key.
  2. Click Next.
  3. Select the Release Bundles or builds to include in the new version.
  4. Click Create.
📘

Note

To change the signing key of an existing Release Bundle version, see Change the Signing Key.

Creating a New Release Bundle Version from the Build Page

If the Release Bundle was created from a single build, you can also return to the build from which the previous version was created and create a Release Bundle with a different version number. By default, the name is the same one that was used for the previous version. (Defining a new name creates a new Release Bundle.) The signing key is predefined with the key that was used for the previous version.

Create a New Release Bundle from the Same Build

To create a new Release Bundle from the same build that was used to create a different Release Bundle, select the Create new name checkbox and enter a new name. After entering a unique name for the new Release Bundle, you have the option to select a different signing key than the one used for the previous Release Bundle.

GA_RB-create-new-name.png
📘

Note

This option is not available for Release Bundles created from multiple builds or from other Release Bundles.