Adding Local Templates (1.31 and higher)

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

To add and use local templates:

  1. In the SCM repository, place your template YAML files (pipelines.yml and values.yml) in a directory named .jfrog-pipelines. This directory can be the root or one level below the root. Directories beyond this level are not supported.

  2. In the Pipelines UI, go toAdministration | Pipelines | Pipeline Sources.

  3. In the resulting Pipeline Sources display, click Add Pipeline Source.

    180126222.jpg

  4. In the resulting Add YAML Pipeline Source page, click one of the following:

    • Single Branch

    • Multi Branch

  5. Complete the Single/Multi Branch form:

    Field

    Description

    Name

    Enter a unique name for the pipeline source.

    SCM Provider Integration

    Click the SCM Provider Integration field and select your source control integration from the dropdown list. Only integrations that are compatible for use as a Pipeline Source will be included in the dropdown list.

    Repository Full Name

    Based on the information you have provided for the selected integration, such as API token, all the relevant repositories are listed in the Repository Full Name field. Select the path of the repository where your pipeline files are stored. If the name of the repository is not auto-fetched, enter the full name of the repository where your pipeline files are stored.

    Branch (Single Branch only)

    Based on the SCM provider and Repository Full Name you have provided, all the available branches are automatically fetched (for example, main). Select the required branch. If the name of the branch is not auto-fetched, enter the name of the branch.

    Exclude (Multi Branch only)

    Specify the Exclude Branch Patternas a regular expression for the matching branch names to exclude.

    Include (Multi Branch only)

    Specify the Include Branch Pattern as a regular expression for the matching branch names to include.

    Sync all branches toggle

    (Multi Branch only)

    When a new multi branch pipeline source is added, only the default branched is synced. To sync all the branches based on the Exclude/Include pattern, click the Sync all branches toggle. If Exclude/Include pattern is not provided, all branches are synced.

    In addition, when a new commit is pushed to thematching branch, that particular branch is synced.

    Folder Name

    Provide the name of the directory where the template YAML files (pipelines.yml and values.yml) are available.

    • The .jfrog-pipelinesdirectory can contain any number of YAML files.

    • To parse all YAML files in the root directory, enter ".".

  6. Click Create Source to complete adding the Pipeline Source.