The following plugin provides functionality available through
Pipeline-compatible steps. Read more about how to integrate steps into your
Pipeline in the
Steps
section of the
Pipeline Syntax
page.
For a list of other such plugins, see the
Pipeline Steps Reference
page.
File Operations Plugin
fileOperations
: File Operations
fileOperations
Array / List of Nested Choice of Objects
fileCopyOperation
includes
Files included to copy, this supports ant-style file pattern ex: target/*/final*.xml
excludes
Files excluded from copying, this supports ant-style file pattern ex: target/*/final*.xml
targetLocation
Destination folder location to copy the files. Base directory is workspace.
flattenFiles
If selected, files are copied directly to the target location without preserving source file sub-directory structure.
renameFiles
By default, the file name of the source file is preserved. When flattening files, this can cause problems if files of the same name exist in multiple source sub-directories. Selecting this option allows the output file name to be manipulated to avoid file name clashes.
sourceCaptureExpression
Java-style regular expression that is run against the full path of each matching source file. This should be used to capture parts of the path that will be used in the target name expression to make each file name unique across all subdirectories.
targetNameExpression
An expression that provides the desired target file name. This can reference variables captured in the source capture expression by using $1, $2 etc.
fileCreateOperation
fileName
Path and Name of the file to be created in workspace.
fileContent
File content to be created, use environment variables where needed.
fileDeleteOperation
includes
Files included to delete, this supports ant-style file pattern ex: target/*/final*.xml
excludes
Files excluded from deleting, this supports ant-style file pattern ex: target/*/final*.xml
fileDownloadOperation
url
Url of the file to download.
userName
password
targetLocation
Destination location to download the file. Base directory is workspace.
targetFileName
proxyHost
proxyPort
fileJoinOperation
sourceFile
Source file path to copy the content.
targetFile
Target file path to append the content from source file.
filePropertiesToJsonOperation
sourceFile
Source file path of properties.
targetFile
Target file path to create or update with json data.
fileRenameOperation
source
destination
Destination file location to rename. Base directory is workspace.
fileTransformOperation
includes
Files included to copy, this supports ant-style file pattern ex: target/*/final*.xml
excludes
Files excluded from copying, this supports ant-style file pattern ex: target/*/final*.xml
fileUnTarOperation
filePath
Source tar file location.
targetLocation
Destination folder location to untar the files. Base directory is workspace.
isGZIP
fileUnZipOperation
filePath
Source zip file location.
targetLocation
Destination folder location to unzip the files. Base directory is workspace.
fileZipOperation
folderPath
Path of the file or folder to create a zip file for, relative to the workspace directory.
outputFolderPath
Path to a target directory for the zip file, relative to the workspace directory. Defaults to workspace directory if not defined.
folderCopyOperation
sourceFolderPath
destinationFolderPath
Destination folder location to copy the files. Base directory is workspace.
folderCreateOperation
folderPath
Path and Name of the folder to be created in workspace.
folderDeleteOperation
folderPath
Path and Name of the folder to be deleted in workspace.
folderRenameOperation
source
destination
Destination folder name to rename. Base directory is workspace.
Was this page helpful?
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.