Managing Pipelines Extensions

JFrog Pipelines Documentation

ft:sourceType
Paligo

Pipelines users can view the catalog of successfully loaded extensions, and manage lifecycle staging of each extension version.

Viewing Extensions

From the Application tab, go to Pipelines | Reusables, and select the Steps/Resources tab to view the list of extensions steps/resources.

stepsTab_31may23.png

Property

Description

Name

The named type of the extension.

Type

This could be either a native step/resource or an extensions step/resource.

Version

The current version of the extensions step/resource.

Platforms

The support platform for the extensions step/resource.

Managing Extensions
Releasing Extension Versions (1.38 and lower)

An extension that has been properly Git tagged with semantic version information can be formally released. When an extension is released, it can be referenced by its version number in a Pipelines DSL. That version of the extension will continue to be available even after a new latest version has been synced from the extension source.

To release the latest version:

  1. Create a git tag in the extension source repository using the format: <extension namespace>/<extension name>@<semver>.

    The format of <semver> must be compliant with the semantic versioning standard (Major.Minor.Patch).

    Example: jfrog/foo@1.0.1.

  2. After a git tag is created in the template source, on the Templates page, either right-click or hover over the rightmost region of the row where the extension is listed to reveal the Actions icon, and then clickRelease.

    extensions_release.png
  3. In the subsequent Release Extension dialog, select the release tag from the dropdown, then click Confirm.

    image2020-9-21_10-20-17.png
Viewing Documentation

If your extension source includes a readme file, you can view the contents of this file. To do this, either right-click or hover over the rightmost region of the row where the extension definition file is listed to reveal the Actions icon, and then click Documentation.

extensions_documentation_1.png
Viewing the Version Log (1.38 and lower)

To view logs:

  1. Either right-click or hover over the rightmost region of the row where the extension version is listed to reveal the Actions icon, and then click Logs.

    extensions_logs_1.png
  2. The Sync Logs for the released extension will be displayed.

    extensions_sync_logs_1.png
Retiring Extension Versions (1.38 and lower)

Retiring an extension version will make it unavailable for further use in a Pipelines DSL. You can select an advance date for a version's retirement.

  1. Either right-click or hover over the rightmost region of the row where the extension version is listed to reveal the Actions icon, and then click Retire.

    extensions_retire_1.png
  2. In the resulting RETIRE EXTENSION dialog, click the Pick a Date (From) box to reveal the calendar, select a date when the extension is to be retired, then click Save.

    extensions_retire_2.png

The row of the extension version will be updated to show the retirement date.

Managing Extension Sources

An Extension Source represents a source control repository (such as GitHub or BitBucket) where Pipelines extension definition files can be found. An extension source connects to the repository through an administration integration.

Once an extension source is added, Pipelines will automatically load all extension definition files from that repository and its sub-directories.

Adding an Extension Source

Note

  • Only an administrator user or a user with resource manager permissions can add an extension source.Introduction to Users and Groups

  • Only one extension source can be added at this time.

Prerequisites for extension sources:

  1. An administration integration must be available for the source control account.

  2. The source code repository for your extensions must be structured according to the requirements for the step model and resource model.

To add an Extension Source:

  1. From the Application module, go to Pipelines | Reusables.

  2. Select the Sources tab, click Add Source and then click Extensions.

  3. In the resulting Add Extension Source display, select the source control account integration, enter the repository path and branch, then click Create Source.