Create a New Release Bundle through the Platform UI

JFrog Distribution Documentation

Products
JFrog Distribution
Content Type
User Guide
ft:sourceType
Paligo

Important

This section describes how to create Release Bundles v1. For information about creating Release Bundles v2, which were introduced in Artifactory 7.63.2 as part of Release Lifecycle Management, see Create Release Bundles (v2).Release Lifecycle ManagementCreate Release Bundles (v2)

You can use the platform UI to create a Release Bundle containing the artifacts to be distributed. This includes general details about the Release Bundle, the AQL queries that define its contents, and optional release notes containing additional information about the Release Bundle.

To create a Release Bundle v1 using the platform UI:

  1. From the Application module, select Distribution | Distributable, and then click New Release Bundle.

    DIST_Release_Bundle_main.png

    This displays the New Release Bundle window.

    new_release_bundles.png
  2. Enter the Release Bundle details according to the general details below, and then click Create Query (see Adding a Query for details).

The Release Bundle page is divided into three panels: General Details, Spec , and Release Notes.

General Details

Field

Description

Name

The Release Bundle name. The Release Bundle name must start with an alphanumeric character followed by an alphanumeric or one of the following characters: - _ : .

Version

The Release Bundle version.

Description

The Release Bundle description.

Spec

This section specifies the Artifactory service from which the Release Bundle will be assembled (remember, a Release Bundle can only be assembled from a single Artifactory service) and the different queries that will be used to assemble the artifacts. For more details on how to define the queries, see Adding a Query.

Field

Description

Name

The query name.

Query

The query details.

Release Notes

This section specifies release notes for the Release Bundle.

Field

Description

Type

The release notes format. Supported types include Markdown, Asciidoc and Plain Text.

Warning

Starting with Distribution 2.26.1, users are restricted from adding HTML tags to release notes written in Markdown. This behavior is controlled by the enable-sanitize-release-notes configuration property, which is set to true by default.Distribution Application Config YAML File

To keep the platform safe against possible cross-site scripting (XSS) attacks, it is recommended to not change this setting.

Edit | Preview

Use these links to edit the release notes in your selected format and then preview how they will look once rendered.