tutorials/HealthCheck - A step that performs a health check action to a website, with optional notification to a Slack instance on success and failure.
tutorials/test - A resource type that holds some example data types
Add and Sync Extensions
To add your Pipelines DSL extension definitions so they can be used in your pipelines, you must add the forked repository to Pipelines as an extension source.
Add an Administration Integration
This procedure can only be performed by an administrator user or resource manager user.
To add an administrator integration for Pipelines DSL extensions:
- From the Administration module go to Pipelines | Integrations .
- From the Integrations view, click Add an Integration.
- In the resulting Add New Integration display, click the Admin radio button and then complete the entries for your VCS account and click Create.
- After entering all the relevant details for the integration, click Test Connection to validate all the details you have entered, including the URL, user credentials, and the token for sufficient permissions on the repository.
Add an Extension Source
Once the VCS account has been added to the administration integrations, you can add your source code repository as an extension source.
For example, our sample repository folder structure is:
jfrog-pipelines-extensions-sample -- steps ------ tutorials –- HealthCheck |
– resources -- tutorials -- test
tutorials identifies the namespace for each set of
To add an Extension Source:
- From the Application module go to Pipelines | Extensions & Templates.
- Select the Sources tab, then click Add Source, and then click Extensions.
- In the resulting Add Extension Source display, select the VCS account integration added above, enter the repository path and branch, then click Create Source.
Pipelines syncs the extension source to load the extensions.
Click the Logs column to view the results of the sync.
View the Extensions tab to see the list of successfully loaded Pipelines DSL extensions.
The example pipeline
MyHealthCheck is in the
pipeline branch of the repository. The
MyHealthCheck pipeline will test the newly added step and resource extensions.
Add the Pipeline Source
To load the example pipeline in your Pipelines deployment, add the
pipeline branch of the repository as a Single Branch Pipeline Source.
If you have not already, you will need to add an integration for your GitHub account. Note that this is in addition to the administration integration added above (even though it is for the same account).
When you click Create Source, the Pipelines DSL file will be synced from the newly added pipeline source. When completed, you can view the Logs for the sync.
Run the Example Pipeline
The newly loaded pipeline MyHealthCheck can be seen in the My Pipelines view.
Click on MyHealthCheck to view its Pipeline History. You can click on the pipeline's single Health_Check_Step to trigger a run of the pipeline.