org.jenkinsci.plugins.pipeline.utility.steps.zip

Class ZipStep

java.lang.Object

hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>

org.jenkinsci.plugins.workflow.steps.Step

org.jenkinsci.plugins.pipeline.utility.steps.zip.ZipStep

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<org.jenkinsci.plugins.workflow.steps.Step>

public class ZipStep
extends org.jenkinsci.plugins.workflow.steps.Step

Creates a zip file.

Author:

Robert Sandell <rsandell@cloudbees.com>.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ZipStep.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
ZipStep(String zipFile)

Method Summary

Modifier and Type	Method and Description
String	getDir() The relative path of the base directory to create the zip from.
String	getGlob() Ant style pattern of files to include in the zip.
String	getZipFile() The name/path of the zip file to create.
boolean	isArchive() If the zip file should be archived as an artifact of the current build.
void	setArchive(boolean archive) If the zip file should be archived as an artifact of the current build.
void	setDir(String dir) The relative path of the base directory to create the zip from.
void	setGlob(String glob) Ant style pattern of files to include in the zip.
org.jenkinsci.plugins.workflow.steps.StepExecution	start(org.jenkinsci.plugins.workflow.steps.StepContext context)

Methods inherited from class org.jenkinsci.plugins.workflow.steps.Step

getDescriptor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ZipStep

@DataBoundConstructor
public ZipStep(String zipFile)
                              throws hudson.model.Descriptor.FormException

Throws:

hudson.model.Descriptor.FormException

Method Detail

getZipFile

public String getZipFile()

The name/path of the zip file to create.

Returns:

the path

getDir

public String getDir()

The relative path of the base directory to create the zip from. Leave empty to create from the current working directory.

Returns:

the dir

setDir

@DataBoundSetter
public void setDir(String dir)

The relative path of the base directory to create the zip from. Leave empty to create from the current working directory.

Parameters:

dir - the dir

getGlob

public String getGlob()

Ant style pattern of files to include in the zip. Leave empty to include all files and directories.

Returns:

the include pattern

setGlob

@DataBoundSetter
public void setGlob(String glob)

Ant style pattern of files to include in the zip. Leave empty to include all files and directories.

Parameters:

glob - the include pattern

isArchive

public boolean isArchive()

If the zip file should be archived as an artifact of the current build. The file will still be kept in the workspace after archiving.

Returns:

if it should be archived or not

setArchive

@DataBoundSetter
public void setArchive(boolean archive)

If the zip file should be archived as an artifact of the current build. The file will still be kept in the workspace after archiving.

Parameters:

archive - if it should be archived or not

start

public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext context)
                                                         throws Exception

Specified by:

start in class org.jenkinsci.plugins.workflow.steps.Step

Throws:

Exception