Cloud customer?
 Upgrade in MyJFrog >



Pipelines Extension is a user-defined extension of the Pipelines DSL. A Pipelines user can specify source repositories to load and process extension definition files from, as well as view and manage lifecycle staging of each extension version.

Page Contents

Managing Extensions

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 | Extensions, and select the Extensions tab. The the list of extensions most recently synced from extension sources are shown under Latest.

The named type of the extension.
The namespace of the extension.
Resource Type
The class of the extension (e.g., resource or step)
Extension Source
The source repository path of the extension.

Administering Extension Versions

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. In Latest, hover over the rightmost region of the row where the extension is listed to reveal the Release icon, then click.
  2. In the subsequent  Release Extension  dialog, select the release tag from the dropdown, then click Confirm.

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

Viewing Documentation

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

Viewing the Version Log

  1. In Released, hover over the rightmost region of the row where the extension version is listed to reveal the Logs icon, then click.
  2. The Sync Logs for the released extension will be displayed.

Retiring Extension Versions

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. In Released, hover over the rightmost region of the row where the extension version is listed to reveal the Edit Released Data icon, then click.
  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.

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 subdirectories. 

Viewing Extension Sources

To view the the list of configured extension sources, from the Application tab go to Pipelines | Extensions, and select the Extension Sources tab.

The tab displays the list of configured extension sources that Pipelines will load extensions from.

Each row of the extension sources list includes the following:

The source repository path of the extension source
The source repository branch
Latest Status
The success/failure status of the last sync
Last Sync
The time and date of the last sync
Changed By
The username of the VCS user who made the triggering change
The commit SHA that triggered the last sync
Click the Logs link to view the log from the last sync. Use this to diagnose a failure to sync a pipeline source.

Sync Extension Source

When any of the pipeline config files have changed, you may need to manually sync the pipeline source to reload:

  1. Hover over the row in the extension source list at the far right until the Sync icon appears.
  2. Click the Sync icon.

If the Status indicates that the sync failed, click Logs to view the logs of all synchronized files.

Adding an Extension Source

An extension source can be added only by an administator user or a user with resource manager permissions. 

Currently, Pipelines permits only a single extension source.

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 | Extensions.
  2. Select the Extension Sources tab, then click Add an Extension Source .
  3. In the resulting Add Extension Source display, select the source control account integration, enter the repository path and branch, then click Create Source.

Pipelines will sync the extension source to load the extensions. 

Copyright © 2021 JFrog Ltd.