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 & Templates, and select the Extensions tab to view the list of extensions.
Name | The named type of the extension. |
Version | The current version of the extension. |
Status | The success/failure status of the last sync. |
Namespace | The namespace of the extension. |
Type | The class of the extension (e.g., resource or step) |
Released At | The date and time when the extension was released. |
Retired At | The date and time when the extension was retired. |
Releasing 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:
- 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. - 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 click Release.
- 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, 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.
Viewing the Version Log
To view logs:
- 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.
- 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.
- 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.
- 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 sub-directories.
Adding an Extension Source
- Only an administrator user or a user with resource manager permissions can add an extension source.
- Only one extension source can be added at this time.
Prerequisites for extension sources:
- An administration integration must be available for the source control account.
- 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:
- From the Application module, go to Pipelines | Extensions & Templates.
- Select the Sources tab, click Add Source and then click Extensions.
- In the resulting Add Extension Source display, select the source control account integration, enter the repository path and branch, then click Create Source.
Pipelines syncs the extension source to load the extensions.
Viewing Extension Sources
To view the the list of configured extension sources, from the Application tab go to Pipelines | Extensions & Templates, and select the 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:
Repository | The source repository path of the extension source |
Branch | 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 |
Context | The commit SHA that triggered the last sync |
Type | The source type |
Sync Extension Source
When any of the pipeline config files have changed, you may need to manually sync the pipeline source to reload:
- Hover over the row in the extension source list either right-click or click the Action icon that appears at the far right.
- In the list of items that appear, click Sync.
If the Status indicates that the sync failed, click Logs to view the logs of all synchronized files.
