CreateReleaseBundle - Tags

JFrog Pipelines Documentation
Products
JFrog Pipelines
Content Type
User Guide
ft:sourceType
Paligo

This topic lists tags that can be used with CreateReleaseBundle Pipeline steps. For more information about CreateReleaseBundle Pipeline steps, see CreateReleaseBundle.

name

An alphanumeric string (underscores are permitted) that identifies the step.

type

Must be CreateReleaseBundle for this step type.

configuration

Specifies all configuration selections for the step's execution environment. This step inherits the Bash/ PowerShell step configuration tags, including these pertinenttags:

Tag

Description of usage

Required/Optional

inputResources

Must specify either a named BuildInfo resource(s) or an Aql resource. CreateReleaseBundle step does not accept other input resources.

If BuildInfo inputResources are provided, the query for the release bundle is constructed using the buildName, buildNumber, and targetRepo of each BuildInfo input.

Required

outputResources

Must specify a ReleaseBundleresource.

The name, version, and isSigned settings in the output ReleaseBundle are updated to the step's releaseBundleName, releaseBundleVersion, and sign values respectively (or any environment variable values that replaced environment variable placeholders for those values).

Required

In addition, these tags can be defined to support the step's native operation:

Note

All native steps derive from the Bash step. This means that all steps share the same base set of tags from Bash, while native steps have their own additional tags as well that support the step's particular function. So it's important to be familiar with the Bash step definition, since it's the core of the definition of all other steps.

Tag

Description of usage

Required/Optional

releaseBundleName

An alphanumeric name for the release bundle.

Required

releaseBundleVersion

Version string for the release bundle.

Required

dryRun

When set to true parse and validate only to test whether a release bundle version can be created.

Default is true.

Optional

sign

Specifies whether the release bundle version will be signed as part of this step.

Default is false.

GPG Signing Key Passphrase

When configuring sign=true, and when your Distribution release bundle GPG signing keyis passphrase protected, remember to provide the GPG Signing Key Passphrase when creating/updating your Distribution Integration.GPG Signing

Optional

description

Description of the release bundle.

Optional

releaseNotes

Describes the release notes for the release bundle version.

syntax specifies the format of release notes: plain_text, markdown, or asciidoc. Default is plain_text.

content is the release notes string in the specified syntax format. Use the | character to denote a string preserving newlines.

Optional

failOnValidate

Fail the step if one of the signatures of the BuildInfo input resource artifacts cannot be verified.

Default is false.

Optional ( Signed Pipelines must be enabled)

execution

Declares collections of shell command sequences to perform for pre- and post-execution phases:

Tag

Description of usage

Required/Optional

onStart

Commands to execute in advance of the native operation

Optional

onSuccess

Commands to execute on successful completion

Optional

onFailure

Commands to execute on failed completion

Optional

onComplete

Commands to execute on any completion

Optional

The actions performed for the onExecute phase are inherent to this step type and may not be overridden.

Note

onExecute, onStart, onSuccess, onFailure, and onComplete are reserved keywords. Using these keywords in any other context in your execution scripts can cause unexpected behavior.