JFrog Pipelines Documentation

Products: JFrog Pipelines
Content Type: User Guide

JFrog Pipelines
JFrog Pipelines Workflow Automation Overview
Pipelines Use Cases
Pipelines Concepts
Connections
Pipelines
Runtimes
Pipelines Step-By-Step
Administrators and Developers
Creating and Running a Pipeline
Pipelines Quickstart
Pipeline Example: Hello World
jfrog-pipelines-hello-world.yml
Pipeline Example: Docker Build and Push
Docker and Build Push Example: pipelines.yml
Pipeline Example: Release to Edge Node
Release to Edge Node Example: pipelines.yml
Pipeline Example: Go Build
Pipeline Example: Npm Build
Npm Build Example: pipelines.yml
Pipeline Example: Maven Build
Pipeline Example: Helm Blue-Green Deploy
Configuring Pipelines
Pipeline Administration Modules
Managing Pipelines Integrations
Add an Integration
Restrict Integration Use
View Integrations
Modify an Integration
Delete an Integration
Share Integrations across Multiple Projects
Managing Pipeline Sources
Add a Pipeline Source (1.31.0 and higher)
Validate YAML
View Pipeline Sources
Sync a Pipeline Source
View Sync Logs
Delete a Pipeline Source
Fetch Branches
Pipeline Source Sync Recovery
Managing Pipelines Node Pools
Administering Dynamic Node Pools
Add a Dynamic Node Pool
Pipeline Node Duration
Dynamic Pipeline Node Caching
Supported Architecture and Operating Systems of Dynamic Nodes
Administering Static Node Pools
Add a Static Node Pool
Administering All Node Pools
Restrict Node Pool Use
View Available Node Pools
Node Provision Status
View Node Pool Details
Modify or Remove a Node Pool
Share Node Pools across Multiple Projects
Creating Custom VM Images
Building a Custom Pipelines Build Plane VM Image using Hashicorp Packer
Adding the VM Image to Pipelines using API
Adding the VM Image to Pipelines using UI
Creating Dynamic Nodes on Kubernetes
Managing Pipelines Static Nodes
Add a Static Node
Add an Air-Gapped Static Node
Initialize a Node
View a Node
Re-initialize a Node
Modify a Node
Remove a Node
Sending Pipelines Nodes Agent Logs to Logstash
Creating Pipelines
Defining a Pipeline
Pipeline Config Structure
Resources Section
Pipelines Section
Pipeline Configuration
Pipeline Steps
Pipeline Config File Strategies
Pipelines Integrations
Airbrake Integration
Artifactory Integration
AWS Keys Integration
Azure Keys Integration
Digital Ocean Integration
Bitbucket Integration
Bitbucket Server Integration
Distribution Integration
Docker Registry Integration
File Server Integration
Generic Integration
GitHub Integration
GitHub Enterprise Integration
GitLab Integration
Google Cloud Integration
Jenkins Integration
Jenkins Server Integration
JFrog Platform Access Token Integration
Jira Integration
Incoming Webhook Integration
Kubernetes Integration
NewRelic Integration
Outgoing Webhook Integration
PagerDuty Events Integration
PEM Key Integration
Slack Integration
SMTP Credentials Integration
Sonar Integration
SSH Key Integration
Pipelines Resources
Pipeline Resource Scope and Visibility
Pipeline Resource Types
Pipeline Resource Versions
Creating Resources
Using Resources
Viewing Resources in the UI
Resetting Resources in the UI
Advanced Usage of Resources
Use Resources Values in Environment Variables
Use Stateful Resources
Use Extension Resources
Aql
AQL YAML Schema
AQL Tags
AQL Examples
Artifact
Artifact YAML Schema
Artifact Tags
Artifact Environment Variables
Artifact Examples
Artifact Troubleshooting
BuildInfo
BuildInfo YAML Schema
BuildInfo Tags
BuildInfo Environment Variables
BuildInfo Examples
Code Analysis
CronTrigger
CronTrigger YAML Schema
CronTrigger Tags
CronTrigger Environment Variables
CronTrigger Examples
DistributionRule
DistributionRule YAML Schema
DistributionRule Tags
DistributionRule Environment Variables
DistributionRule Example
FileSpec
FileSpec YAML Schema
FileSpec Tags
FileSpec Environment Variables
FileSpec Examples
GitRepo
GitRepo YAML Schema
GitRepo Tags
GitRepo Environment Variables
GitRepo Examples
HelmChart
HelmChart YAML Schema
HelmChart Tags
HelmChart Environment Variables
HelmChart Example
Image
Image YAML Schema
Image Tags
Image Environment Variables
Image Examples
IncomingWebhook
IncomingWebhook YAML Schema
IncomingWebhook Tags
IncomingWebhook Environment Variables
IncomingWebhook Example
OutgoingWebhook
OutgoingWebhook YAML Schema
OutgoingWebhook Examples
OutgoingWebhook Environment Variables
OutgoingWebhook Examples
PropertyBag
PropertyBag YAML Schema
PropertyBag Tags
PropertyBag Environment Variables
PropertyBag Examples
ReleaseBundle
ReleaseBundle YAML Schema
ReleaseBundle Tags
ReleaseBundle Environment Variables
ReleaseBundle Examples
RemoteFile
RemoteFile YAML Schema
RemoteFile Tags
RemoteFile Environment Variables
RemoteFile Examples
VmCluster
VmCluster YAML Schema
VmCluster Tags
VmCluster Environment Variables
VmCluster Example
Pipelines Steps
Bash
Bash - Usage
Bash - Tags
Bash - Examples
CreateReleaseBundle
CreateReleaseBundle - YAML Schema
CreateReleaseBundle - Tags
CreateReleaseBundle - Examples
CreateReleaseBundle - How it Works
DistributeReleaseBundle
DistributeReleaseBundle - YAML Schema
DistributeReleaseBundle - Tags
DistributeReleaseBundle - Examples
DistributeReleaseBundle - How it Works
DockerPush
DockerPush - YAML Schema
DockerPush - Tags
DockerPush - Examples
DockerPush - How it Works
DockerBuild
DockerBuild - YAML Schema
DockerBuild - Tags
DockerBuild - Examples
DockerBuild - How it Works
GoBuild
GoBuild - YAML Schema
GoBuild - Tags
GoBuild - Examples
GoBuild - How it Works
GoPublishBinary
GoPublishBinary - YAML Schema
GoPublishBinary - Tags
GoPublishBinary - Examples
GoPublishBinary - How it Works
GoPublishModule
GoPublishModule - YAML Schema
GoPublishModule - Tags
GoPublishModule - Examples
GoPublishModule - How it Works
GradleBuild
GradleBuild - YAML Schema
GradleBuild - Tags
GradleBuild - Examples
GradleBuild - How it Works
HelmBlueGreenCleanup
HelmBlueGreenCleanup - YAML Schema
HelmBlueGreenCleanup - Tags
HelmBlueGreenCleanup - Examples
HelmBlueGreenCleanup - How it Works
HelmBlueGreenDeploy
HelmBlueGreenDeploy - YAML Schema
HelmBlueGreenDeploy - Tags
HelmBlueGreenDeploy - Examples
HelmBlueGreenDeploy - How it Works
Pipelines Managed Services
HelmBlueGreenRoleSwitch
HelmBlueGreenRoleSwitch - YAML Schema
HelmBlueGreenRoleSwitch - Tags
HelmBlueGreenRoleSwitch - Examples
HelmBlueGreenRoleSwitch - How it Works
Pipelines Managed Services
HelmDeploy
HelmDeploy - YAML Schema
HelmDeploy - Tags
HelmDeploy -Examples
HelmDeploy - How it Works
HelmPublish
HelmPublish - YAML Schema
HelmPublish - Tags
HelmPublish - Examples
HelmPublish - How it Works
Jenkins
Jenkins - YAML Schema for Pipeline Steps
Jenkins - Tags for Pipeline Steps
Jenkins - Examples for Pipeline Steps
LinuxVMDeploy
Matrix
Matrix - Usage
Matrix - Tags
Matrix - Examples
MvnBuild
MvnBuild - YAML Schema
MvnBuild - Tags
MvnBuild - Examples
MvnBuild - How it Works
NpmBuild
NpmBuild - YAML Schema
NpmBuild - Tags
NpmBuild - Examples
NpmBuild - How it Works
NpmPublish
NpmPublish - YAML Schema
NpmPublish - Tags
NpmPublish - Examples
NpmPublish - How it Works
PreMatrix
PreMatrix - Usage
PreMatrix - Tags
PostMatrix
PostMatrix - Usage
PostMatrix -Tags
PowerShell
PowerShell - Usage
PowerShell - Tags
PowerShell - Example
PromoteBuild
PromoteBuild - YAML Schema
PromoteBuild - Tags
PromoteBuild - Examples
PromoteBuild - How it Works
PublishBuildInfo
PublishBuildInfo - YAML Schema
PublishBuildInfo - Tags
PublishBuildInfo - Examples
PublishBuildInfo - How it Works
SignReleaseBundle
SignReleaseBundle - YAML Schema
SignReleaseBundle - Tags
SignReleaseBundle - Examples
SignReleaseBundle - How it Works
TriggerPipeline
TriggerPipeline - YAML Schema
TriggerPipeline - Tags
TriggerPipeline - Examples
TriggerPipeline - How it Works
UploadArtifact
UploadArtifact - YAML Schema
UploadArtifact - Tags
UploadArtifact - Examples
UploadArtifact - How it Works
XrayScan
XrayScan - YAML Schema
XrayScan - Tags
XrayScan - Examples
XrayScan - How it Works
Pipelines Utility Functions
bump_semver
replace_envs
retry_command
get_uuid
save_artifact_info
validate_artifact
configure_jfrog_cli
use_jfrog_cli
check_xray_available
cleanup_jfrog_cli
set_trigger_payload
get_trigger_payload
Source Control
compare_git
update_commit_status
Test Reports
Encryption
encrypt_string
decrypt_string
encrypt_file
decrypt_file
Notifications
JSON
set_payload
read_json
Resources
replicate_resource
write_output
Caching
add_cache_files
restore_cache_files
Run State Management
add_run_variables
export_run_variables
add_run_files
set_run_name
update_run_description
restore_run_files
Affinity Group State Management
add_affinity_group_files
restore_affinity_group_files
Pipeline State Management
add_pipeline_variables
export_pipeline_variables
add_pipeline_files
restore_pipeline_files
Step Properties
find_resource_variable
get_integration_name
get_resource_name
get_resource_names
get_affinity_group_step_names
find_step_configuration_value
end_step
Pipelines Environment Variables
Standard Environment Variables
Reserved Environment Variables
User-defined Environment Variables
Environment Variables Configuration
Access Integration Properties
Access Resource Properties
Run State
Pipeline State
Pipelines Templates
Global Templates
HelloWorld
GoCI
GradleCI
MavenCI
NpmCI
PromoteCI
DockerBuildAndPush
HelmPublishAndDeploy
Artifactory Artifact Cleanup Template (1.40 and higher)
Using Global Templates to Create a Pipeline Source (1.31 and higher)
System Templates
Add System Template (1.31.0 and higher)
Develop and Test Templates
Template Functions List
Structure of Template Source Repository (1.30 and lower)
Add System Templates (1.30 and lower)
Local Templates
Template Functions List
Adding Local Templates (1.31 and higher)
Adding Local Templates (1.30 and Lower)
View Templates
View Pipeline Template Definition, Values Example and Documentation
Retire Template Versions
Pipelines Tasks
Creating Pipeline Tasks
Viewing Pipeline Tasks
Using Pipeline Tasks
build-publish
create-incident
curate-artifact
docker-build
docker-push
email-notify
frogbot
Frogbot 0.1.0
Frogbot 0.0.3
go-build
go-security-check
go-static-check
go-static-check 0.1.0
go-static-check 0.0.2
gradle-build
jira-comment
jira-transition
mvn-build
npm-build
Release Bundle V2
run-cypress
run-status
setup-go
setup-go 0.1.0
setup-go 0.0.3
setup-java
setup-jfrog-cli
setup-node
setup-yarn
slack-notify
sonar
update-incident
upload-artifact
upload-file-to-s3
xray-scan
Extending Pipelines
Pipelines Extension Resource Model - Tags
Pipelines Extension Expressions
Extension Data Types
Extension Validation Expressions
Pipelines Extension Resource Model
Pipelines Extension Resource Model - Files
Pipelines Extension Resource Model - Syntax Model
Pipelines Extension Resource Model - Tags
Pipelines Extension Resource Model - Shell Scripts
Pipelines Extension Step Model
Pipelines Extension Step Model - Files
Pipelines Extension Step Model - Syntax Model
Pipelines Extension Step Model - Tags
Pipelines Extension Step Model- Shell Scripts
Pipelines Extension Usage
Pipelines Extension Usage - Namespaces
Pipelines Extension Usage - Versioning
Tag Extension Versions
Release Extension Versions
Use Extension Versions
Pipelines Extensions Tutorial
Pipelines Extensions Tutorial - Add and Sync Extensions
Pipelines Extensions Tutorial - Example Pipeline
Managing Pipelines Extensions
View Pipeline Extensions
Manage Pipeline Extensions
Manage Pipeline Extension Sources
Working with Pipelines
View and Navigate Pipeline Information
Pipelines Views
All Pipelines and Admin Views
My Views (Pipelines)
Active Pipeline Runs
Browsing Pipelines
List Pipelines
Pipeline Graphs (Pipeline of Pipelines)
Pipeline Favorites
Multibranch Pipeline Views
Active Pipeline Runs
Pipeline History
Choose a Pipeline
View a Pipeline
Search a Pipeline
Filter Pipeline Steps
Zoom a Pipeline
View Information about a Pipeline Step or Resource
Trigger and Cancel a Pipeline Step
View Pipeline Step History
View Pipeline YAML
Open Pipeline Source
Delete a Pipeline
View all Pipeline Runs
View Pipeline Run Logs
Filter Pipeline Runs
View Pipeline Run Steps
View Pipeline Run Resources
View Pipeinfo
View Pipeline Runs Charts
Pipeline Run Logs
View Pipeline Run Logs
Matrix Steplet Logs
Running a Pipeline
View Step History
Trigger a Pipeline Run Automatically
Trigger a Pipeline Run Manually
View Step Execution
Cancel Runs and Steps
Cancel a Specific Step
Cancel a Specific Run
Cancel Multiple Runs
Step Status
Pipelines Insights
Insights - Performance
Insights - Tests
Insights - Code
Custom View Insights - Performance
Custom View Insights - Tests
DORA Metrics
Using Pipelines
Breaking Your Pipelines into Steps
Triggering Pipelines and Steps
Triggering On a Git Repository Change
Triggering On a Webhook
Triggering On a Time Schedule
Creating Stateful Pipelines
Types of Pipeline State
Pipeline Run State
Pipeline State
Pipeline Resource-based State
Inserting Secrets in Pipelines
Use Standard Integrations
Use the Generic Integration
Running Multiple Steps on the Same Build Node
Sending Notifications from Pipelines
Sending Notifications to a Slack Channel or User
Sending Notifications to Email
Creating Jira Issues from Pipelines
Add a Jira Integration for Pipelines
Create a Jira Issue as part of a Pipeline
Sending Build Status to Source Control
Source Control Build Status
Send Source Control Build Status from Pipelines
Example Build Status Message Pipeline
Recording Unit Test Results
Save Record Unit Test Results
Example Pipeline for Unit Test Results
Deploying to Kubernetes in Pipelines
Create the Helm Chart for Pipelines in Kubernetes
Using a Docker Image for Pipelines in Kubernetes
Publish the Helm Chart for Pipelines
Deploying to Kubernetes in Pipelines
Example of Deploying to Kubernetes in Pipelines
Setting Up Maven Builds for Pipelines
Caching Step Runtimes
Creating Multibranch Pipelines
Configure a Multibranch Pipeline Source
Declare a Multibranch Pipeline
Run Multibranch Pipelines
Using Jenkins With Pipelines
Run a Jenkins Job From Pipelines
Jenkins Server Integration with Pipelines
Pipelines DSL
Jenkins Build Job for Pipelines
Using the Matrix Step
Single Dimension Matrix
Two-Dimension Matrix
Matrix Pipeline Example
Multi-Node Matrix
Multi-Node Pool Matrix
Setting Retention Policy
Set Retention Policy at System-level
Set Retention Policy at Pipeline-level
Signed Pipelines
Signing Process for Pipelines
Pipe-Info Repository
View Metadata for Signed Pipelines
Storing and Validating Signed Pipelines Data
Setting Step Timeouts
Timeout at Step-level
Timeout at Node Pool-level
Timeout at System-level
Speeding up Pipeline Runs
Cache Step Runtimes
Cache Dynamic Nodes
Choose Node Pools
Use Artifactory Remote Repositories
Use Custom Runtime Image
Use Matrix Step
Run Steps in Parallel
Triggering a Run with Custom Parameters
Customize a Run
Select Steps and Node Pools
Customize Run using Environment Variables
Select Input Resources
Set Custom Run Number
Adding Build Badges
Conditional Workflows
Step Status Conditional Workflow
Run Variable Conditional Workflow
Environment Variables Conditional Workflow
newVersionOnly Conditional Workflow
Viewing Run Logs
Pipeline Workflow Examples
allowFailure Examples
Approval Gates
Configure Approval Gates Step
Environment Variables
Approve/Reject Steps
Pipeline of Pipelines
Embedded Pipelines
Create and Run Embedded Pipelines
Monitoring Pipelines using New Relic APM
Managing Runtimes
Host Runtimes
Container Runtimes
Runtime Concepts
Choosing your Runtime Image
Default Runtime Image
Choosing your Runtime Image
Using a Custom Runtime Image
Running Steps on the Host
Choosing Node Pools
Runtime Images
Current Runtime Docker Images
Retired App/Image Versions
Solving Container Communication Challenges in Pipelines
Troubleshooting
Pipelines Error Messages
Frequently Asked Questions

Back to home page