The following plugins offer Pipeline-compatible steps. Each plugin link offers more information about the parameters for each step.
Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.
AlaudaDeleteBuild
: AlaudaDeleteBuild
alaudaDeployComponent
: Alauda deploy component
alaudaDeployService
: Alauda deploy service
alaudaNotify
: AlaudaNotifier
alaudaSendNotification
: SendNotification
alaudaStartBuild
: alaudaStartBuild
AlaudaDeleteBuild
: AlaudaDeleteBuild
alaudaStartBuild
: alaudaStartBuild
alaudaDeployComponent
: Alauda deploy component
alaudaDeployService
: Alauda deploy service
alaudaRetrieveComponent
: Retrieve the Component
alaudaRetrieveIntegration
: Retrieve the integration
alaudaRetrieveService
: Retrieve the service
ArtifactoryGradleBuild
: run Artifactory gradle
MavenDescriptorStep
: Get Artifactory Maven descriptor
addInteractivePromotion
: Add interactive promotion
artifactoryDistributeBuild
: Distribute build
artifactoryDownload
: Download artifacts
artifactoryEditProps
: Edit properties
artifactoryMavenBuild
: run Artifactory maven
artifactoryNpmInstall
: Run Artifactory npm install
artifactoryNpmPublish
: Run Artifactory npm publish
artifactoryPromoteBuild
: Promote build
artifactoryUpload
: Upload artifacts
collectEnv
: Collect environment variables and system properties
conanAddRemote
: Add new repo to Conan config
conanAddUser
: Add new user to Conan config
deployArtifacts
: Deploy artifacts
dockerPullStep
: Artifactory docker pull
dockerPushStep
: Artifactory docker push
getArtifactoryServer
: Get Artifactory server from Jenkins config
initConanClient
: Create Conan Client
newArtifactoryServer
: Returns new Artifactory server
newBuildInfo
: New buildInfo
newGradleBuild
: New Artifactory gradle executor
newMavenBuild
: New Artifactory maven
newNpmBuild
: New Artifactory npm executor
publishBuildInfo
: Publish build Info to Artifactory
rtAddInteractivePromotion
: Add interactive promotion
rtBuildInfo
: Create build info
rtDeleteProps
: Delete properties
rtDockerPush
: run Artifactory docker push
rtDownload
: Download artifacts
rtGradleDeployer
: set gradle deployer
rtGradleResolver
: set gradle resolver
rtGradleRun
: run Artifactory gradle
rtMavenDeployer
: set maven deployer
rtMavenResolver
: set maven resolver
rtMavenRun
: run Artifactory maven
rtNpmDeployer
: set npm deployer
rtNpmInstall
: run Artifactory npm install
rtNpmPublish
: run Artifactory npm publish
rtNpmResolver
: set npm resolver
rtPromote
: Promote build
rtPublishBuildInfo
: Publish build info
rtServer
: Creates new Artifactory server
rtSetProps
: Set properties
rtUpload
: Upload artifacts
runConanCommand
: Run a Conan command
xrayScan
: run Xray scan
xrayScanBuild
: Xray build scanning
addBadge
: Add Badge
addErrorBadge
: Add Error Badge
addHtmlBadge
: Add a html badge Text
addInfoBadge
: Add Info Badge
addShortText
: Add Short Text
addWarningBadge
: Add Warning Badge
createSummary
: Print Message
removeBadges
: Remove Badges
removeHtmlBadges
: Remove Html Badges
removeSummaries
: Remove Summaries
svDeployTest
: CA Service Virtualization - Deploy Test
svDeployVirtualService
: CA Service Virtualization - Deploy Virtual Service
svStartVirtualService
: CA Service Virtualization - Start Virtual Service
svStopVirtualService
: CA Service Virtualization - Stop Virtual Service
svPublishTestReport
: CA Service Virtualization Report Publisher
svUndeployVirtualService
: CA Service Virtualization - Undeploy Virtual Service
dockerFingerprintFrom
: Record trace of a Docker image used in FROM
dockerFingerprintRun
: Record trace of a Docker image run in a container
withDockerContainer
: Run build steps inside a Docker container
withDockerRegistry
: Sets up Docker registry endpoint
withDockerServer
: Sets up Docker server endpoint
setGitHubPullRequestStatus
: Set GitHub PullRequest Commit Status
githubPRStatusPublisher
: GitHub PR: set PR status
githubPRClosePublisher
: GitHub PR: close PR
githubPRComment
: GitHub PR: post comment
githubPRAddLabels
: GitHub PR: add labels
githubPRRemoveLabels
: GitHub PR: remove labels
gitHubPRStatus
: GitHub PR: set 'pending' status
evaluateGate
: IBM Cloud DevOps Gate
notifyOTC
: Send notification to OTC
publishBuildRecord
: Publish build record to IBM Cloud DevOps
publishDeployRecord
: Publish deploy record to IBM Cloud DevOps
publishSQResults
: Publish SonarQube test results to IBM Cloud DevOps
publishTestResult
: Publish test result to IBM Cloud DevOps
sendDeployableMessage
: Send deployable mapping message to OTC
jiraAddComment
: JIRA Steps: Add Comment
jiraAddWatcher
: JIRA Steps: Add Watcher
jiraAssignIssue
: JIRA Steps: Assign Issue
jiraAssignableUserSearch
: JIRA Steps: Searches assignable JIRA Users by username, name or email address for the given project/issueKey
jiraDeleteAttachment
: JIRA Steps: Delete Attachment
jiraDeleteIssueLink
: JIRA Steps: Delete IssueLink
jiraDeleteIssueRemoteLink
: JIRA Steps: Delete Issue’s Remote Link by linkId.
jiraDeleteIssueRemoteLinks
: JIRA Steps: Delete Issue’s Remote Links by globalId.
jiraDownloadAttachment
: JIRA Steps: Download a file to workspace (directory is optional)
jiraEditComment
: JIRA Steps: Edit Issue Comment
jiraEditComponent
: JIRA Steps: Edit Component
jiraEditIssue
: JIRA Steps: Edit Issue
jiraEditVersion
: JIRA Steps: Edit Version
jiraGetAttachmentInfo
: JIRA Steps: Get Attachment Info
jiraGetComment
: JIRA Steps: Get Issue Comment
jiraGetComments
: JIRA Steps: Get Issue Comments
jiraGetComponent
: JIRA Steps: Get Component
jiraGetComponentIssueCount
: JIRA Steps: Get Component Issue Count
jiraGetFields
: JIRA Steps: Get Fields
jiraGetIssue
: JIRA Steps: Get Issue
jiraGetIssueLink
: JIRA Steps: Get IssueLink
jiraGetIssueLinkTypes
: JIRA Steps: Get Issue Link Types
jiraGetIssueRemoteLink
: JIRA Steps: Get Issue’s Remote Link by linkId.
jiraGetIssueRemoteLinks
: JIRA Steps: Get Issue’s Remote Links by globalId.
jiraGetIssueTransitions
: JIRA Steps: Get Issue Transitions
jiraGetIssueWatches
: JIRA Steps: Get Issue Watches
jiraGetProject
: JIRA Steps: Get Project
jiraGetProjectComponents
: JIRA Steps: Get Project Components
jiraGetProjectStatuses
: JIRA Steps: Get Project Statuses
jiraGetProjectVersions
: JIRA Steps: Get Project Versions
jiraGetProjects
: JIRA Steps: Get Projects
jiraGetServerInfo
: JIRA Steps: Get Server Info
jiraGetVersion
: JIRA Steps: Get Version
jiraJqlSearch
: JIRA Steps: JQL Search
jiraLinkIssues
: JIRA Steps: Link Issues
jiraNewComponent
: JIRA Steps: Create New Component
jiraNewIssue
: JIRA Steps: Create New Issue
jiraNewIssueRemoteLink
: JIRA Steps: Create new remote link for given issue.
jiraNewIssues
: JIRA Steps: Create New Issues
jiraNewVersion
: JIRA Steps: Create New Version
jiraNotifyIssue
: JIRA Steps: Notify Issue
jiraTransitionIssue
: JIRA Steps: Transition Issue
jiraUploadAttachment
: JIRA Steps: Attach a file from workspace to an issue
jiraUserSearch
: JIRA Steps: Search Active JIRA Users by username, name or email address.
klocworkBuildSpecGeneration
: Klocwork - (step 1 - capture) Capture Build Information
klocworkIncremental
: Klocwork - Incremental Diff Analysis
klocworkIntegrationStep1
: Klocwork - (step 2 - analysis) Full Integration Analysis
klocworkIntegrationStep2
: Klocwork - (step 3 - DB load) Full Integration Analysis
klocworkIssueSync
: Klocwork - Cross-Project Issue Sync
klocworkQualityGateway
: Klocwork - Quality Gateway
klocworkWrapper
: Klocwork - Build Environment Settings
createEnvironment
: Creates the testing environment. Locates, installs and waits for installed resources to become ready
currentNamespace
: Returns the current namespace
inNamespace
: Run build steps inside an arquillian cube kubernetes managed namespace
inSession
: Run build steps inside an Arquillian Cube Kubernetes Session
loadRunnerTest
: Run LoadRunner performance scenario tests
runLoadRunnerScript
: Run LoadRunner script
sseBuildAndPublish
: Execute tests using ALM Lab Management and Publish tests result
publishGherkinResults
: Octane Cucumber test reporter
healthAnalyzer
: Micro Focus Health Analyzer
pcBuild
: Execute performance test using Performance Center
runFromAlmBuilder
: Execute Micro Focus functional tests from Micro Focus ALM
addALMOctaneSonarQubeListener
: ALM Octane SonarQube listener
sseBuild
: Execute Micro Focus tests using Micro Focus ALM Lab Management
uploadResultToALM
: Upload test result to ALM
convertTestsToRun
: Micro Focus ALM Octane testing framework converter
svChangeModeStep
: SV: Change Mode of Virtual Service
svDeployStep
: SV: Deploy Virtual Service
svExportStep
: SV: Export Virtual Service
svUndeployStep
: SV: Undeploy Virtual Service
uftScenarioLoad
: Run UFT scenario
nexusPolicyEvaluation
: Invoke Nexus Policy Evaluation
nexusPublisher
: Nexus Repository Manager Publisher
associateTag
: Associate Tag (Nexus Repository Manager 3.x)
createTag
: Create Tag (Nexus Repository Manager 3.x)
deleteComponents
: Delete Components (Nexus Repository Manager 3.x)
moveComponents
: Move Components (Nexus Repository Manager 3.x)
openshiftBuild
: Trigger OpenShift Build
openshiftCreateResource
: Create OpenShift Resource(s)
openshiftDeleteResourceByJsonYaml
: Delete OpenShift Resource(s) from JSON or YAML
openshiftDeleteResourceByKey
: Delete OpenShift Resource(s) by Key
openshiftDeleteResourceByLabels
: Delete OpenShift Resource(s) using Labels
openshiftDeploy
: Trigger OpenShift Deployment
openshiftExec
: OpenShift Exec
openshiftImageStream
: OpenShift ImageStreams
openshiftScale
: Scale OpenShift Deployment
openshiftTag
: Tag OpenShift Image
openshiftVerifyBuild
: Verify OpenShift Build
openshiftVerifyDeployment
: Verify OpenShift Deployment
openshiftVerifyService
: Verify OpenShift Service
createDeploymentEvent
: create Dynatrace Deployment event
activateDTConfiguration
: activate Dynatrace profile configuration
createMemoryDump
: create memory dump
perfSigReports
: Publish Performance Signature reports
startSession
: Start Dynatrace session recording
stopSession
: Stop Dynatrace session recording
createThreadDump
: create thread dump
findFiles
: Find files in the workspace
nodesByLabel
: List of nodes by Label, by default excludes offline nodes.
readCSV
: Read content from a CSV file in the workspace.
readJSON
: Read JSON from files in the workspace.
readManifest
: Read a Jar Manifest
readMavenPom
: Read a maven project file.
readProperties
: Read properties from files in the workspace or text.
readYaml
: Read yaml from files in the workspace or text.
sha1
: Compute the SHA1 of a given file
tee
: Tee output to file
touch
: Create a file (if not already exist) in the workspace, and set the timestamp
unzip
: Extract Zip file
writeCSV
: Write content to a CSV file in the workspace.
writeJSON
: Write JSON to a file in the workspace.
writeMavenPom
: Write a maven project file.
writeYaml
: Write a yaml from an object.
zip
: Create Zip file
awaitDeploymentCompletion
: Wait for AWS CodeDeploy deployment completion
awsIdentity
: Print and return the AWS identity
cfInvalidate
: Invalidate given paths in CloudFront distribution
cfnCreateChangeSet
: Create CloudFormation change set
cfnDelete
: Delete CloudFormation stack
cfnDeleteStackSet
: Delete CloudFormation Stack Set
cfnDescribe
: Describe outputs of CloudFormation stack
cfnExecuteChangeSet
: Execute CloudFormation change set
cfnExports
: Describe CloudFormation global exports
cfnUpdate
: Create or Update CloudFormation stack
cfnUpdateStackSet
: Create or Update CloudFormation Stack Set
cfnValidate
: Validate CloudFormation template
deployAPI
: Deploy the given API Gateway API
ec2ShareAmi
: Share an AMI with other accounts
ecrDeleteImage
: Delete ecr images
ecrListImages
: List ECR Images
ecrLogin
: Create and return the ECR login string
invokeLambda
: Invoke a given Lambda function
listAWSAccounts
: List all AWS accounts of the organization
s3Copy
: Copy file between S3 buckets
s3Delete
: Delete file from S3
s3DoesObjectExist
: Check if object exists in S3
s3Download
: Copy file from S3
s3FindFiles
: Find files in S3
s3PresignURL
: Presign file in S3
s3Upload
: Copy file to S3
setAccountAlias
: Set the AWS account alias
snsPublish
: Publish notification to SNS
updateIdP
: Update thirdparty Identity Provider
updateTrustPolicy
: Update trust policy of IAM roles
withAWS
: set AWS settings for nested block
catchError
: Catch error and set build result to failure
deleteDir
: Recursively delete the current directory from the workspace
dir
: Change current directory
echo
: Print Message
error
: Error signal
fileExists
: Verify if file exists in workspace
isUnix
: Checks if running on a Unix-like node
mail
: Mail
pwd
: Determine current directory
readFile
: Read file from workspace
retry
: Retry the body up to N times
sleep
: Sleep
stash
: Stash some files to be used later in the build
step
: General Build Step
timeout
: Enforce time limit
tool
: Use a tool from a predefined Tool Installation
unstable
: Set stage result to unstable
unstash
: Restore files previously stashed
waitUntil
: Wait for condition
warnError
: Catch error and set build and stage result to unstable
withEnv
: Set environment variables
wrap
: General Build Wrapper
writeFile
: Write file to workspace
archive
: Archive artifacts
getContext
: Get contextual object from internal APIs
unarchive
: Copy archived artifacts into the workspace
withContext
: Use contextual object from internal APIs within a block
sshCommand
: SSH Steps: sshCommand - Execute command on remote node.
sshGet
: SSH Steps: sshGet - Get a file/directory from remote node.
sshPut
: SSH Steps: sshPut - Put a file/directory on remote node.
sshRemove
: SSH Steps: sshRemove - Remove a file/directory from remote node.
sshScript
: SSH Steps: sshScript - Execute script(file) on remote node.
publishATX
: [TT] Publish ATX Reports
generateCache
: [TT] Generate Caches
downstreamPublisher
: [TT] Downstream Report Generation
publishETLogs
: [TT] Publish ECU-TEST Logs
exportPackages
: [TT] Export Packages
exportProjects
: [TT] Export Projects
importPackages
: [TT] Import Packages
importProjects
: [TT] Import Projects
publishUNIT
: [TT] Publish UNIT Reports
publishGenerators
: [TT] Publish Generator Reports
startET
: [TT] Start ECU-TEST
startTS
: [TT] Start Tool-Server
stopET
: [TT] Stop ECU-TEST
stopTS
: [TT] Stop Tool-Server
publishTMS
: [TT] Publish to Test Management System
publishTRF
: [TT] Publish TRF Reports
testFolder
: [TT] Run Test Folder
testPackage
: [TT] Run Package
testProject
: [TT] Run Project
publishTraceAnalysis
: [TT] Publish Trace Analysis
getATXServer
: Get TEST-GUIDE server by name
getETInstallation
: Get ECU-TEST installation by name
isConfigStarted
: Check ECU-TEST configuration status
newATXServer
: Return new TEST-GUIDE server
newETInstallation
: Return new ECU-TEST installation
archiveZap
: Create & Archive ZAP report
importZapScanPolicy
: Import a ZAP scan policy from the specified path
importZapUrls
: Load a list of URLs for ZAP to use from the specified path
runZapAttack
: Run ZAP attack by changing to attack mode and starting the attack
runZapCrawler
: Run ZAP crawler on a specified host
startZap
: Start ZAP process
Please submit your feedback about this page through this quick form.
Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?
See existing feedback here.