Add a Pipeline Source (1.31.0 and higher)

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 YAML config is available.

Recommended Directory Structure for using Folder Name

Here are some examples of the supported directory structure:

If you have a monorepo with multiple services within a single repo, a directory structure such as the following is recommended:

Local Artifactory Token Permissions

When a pipeline source is added to a custom Project, all pipelines associated with this pipeline source will have access to a local Artifactory integration by default. This integration enables you to connect to your local Artifactory instance to push artifacts, without having to explicitly create an Artifactory integration. However, unlike the custom Artifactory integration, which can be used to connect to any Artifactory instance, the local Artifactory integration can only connect to your local Artifactory instance. In addition, while the custom Artifactory integration uses API key for authentication and permissions, the local Artifactory integration uses scoped token.

Permissions

Read permission is enabled by default for all local Artifactory integrations. When required, you can add the following additional permissions for your pipeline source. All pipelines associated with that pipeline source will then use these permissions:

Usage in Pipelines YAML

The local Artifactory integration can be added as an input to any Bash step. To do this, use {{ .jfrog-pipelines.localArtifactory }} as a placeholder for the integration. It can be used at both pipeline-level and step-level.

When you add this integration directly to a Bash step, the JFROG_LOCAL_ARTIFACTORY_TOKEN environment variable is automatically made available to be used at runtime. This environment variable creates a scoped token with read permissions. When the pipeline YAML is added as a pipeline source, the permissions for the token can be elevated to Write, Delete, and/or Manage. If the pipeline source includes more than one pipeline, the new permissions will be applicable for all the pipelines in the source.

resources:
  - name: myRepo_native
    type: GitRepo
    configuration:
      path: jfrog/jfrog_pipelines
      gitProvider: myGithub
      branches:
        include: master

pipelines:
  - name: myPipeline_native
    steps:
      - name: first_step
        type: Bash
        configuration:
          integrations:
            - name: {{.jfrog-pipelines.localArtifactory}}
        execution:
          onExecute:
            - echo "first_step"
            - jfrog config add jftest-$step_id --url https://pipelines.jfrog.io --access-token ${JFROG_LOCAL_ARTIFACTORY_TOKEN}
            - touch test.txt
            - echo "hello" > test.txt
            - jfrog rt upload test.txt demo-sampleRepo/test.txt --server-id jftest-$step_id
      - name: second_step
        type: Bash   
        configuration:
          inputSteps:
            - name: first_step
        execution:
          onExecute:
            - echo "second_step"
            - echo "$JFROG_LOCAL_ARTIFACTORY_TOKEN"