com.cloudbees.dockerpublish

Class DockerBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

com.cloudbees.dockerpublish.DockerBuilder

All Implemented Interfaces:

ExtensionPoint, Describable<Builder>, BuildStep

public class DockerBuilder
extends Builder

Plugin to build and publish docker projects to the docker registry/index. This can optionally push, and bust cache.

Author:

Michael Neale

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DockerBuilder.DescriptorImpl Descriptor for DockerBuilder.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

BuildStep.PublisherList

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
DockerBuilder(String repoName)
DockerBuilder(String repoName, String repoTag, boolean skipPush, boolean noCache, boolean forcePull, boolean skipBuild, boolean skipDecorate, boolean skipTagLatest, String dockerfilePath) Deprecated.

Method Summary

Modifier and Type	Method and Description
String	getBuildAdditionalArgs()
String	getBuildContext()
DockerBuilder.DescriptorImpl	getDescriptor()
String	getDockerfilePath()
String	getDockerToolName()
org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint	getRegistry()
String	getRepo() Fully qualified repository/image name with the registry url in front
String	getRepoName()
String	getRepoTag()
org.jenkinsci.plugins.docker.commons.credentials.DockerServerEndpoint	getServer()
boolean	isCreateFingerprint()
boolean	isForcePull()
boolean	isForceTag()
boolean	isNoCache()
boolean	isSkipBuild()
boolean	isSkipDecorate()
boolean	isSkipPush()
boolean	isSkipTagLatest()
boolean	perform(AbstractBuild build, Launcher launcher, BuildListener listener)
void	setBuildAdditionalArgs(String buildAdditionalArgs)
void	setBuildContext(String buildContext)
void	setCreateFingerprint(boolean createFingerprint)
void	setDockerfilePath(String dockerfilePath)
void	setDockerToolName(String dockerToolName)
void	setForcePull(boolean forcePull)
void	setForceTag(boolean forceTag)
void	setNoCache(boolean noCache)
void	setRegistry(org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint registry)
void	setRepoTag(String repoTag)
void	setServer(org.jenkinsci.plugins.docker.commons.credentials.DockerServerEndpoint server)
void	setSkipBuild(boolean skipBuild)
void	setSkipDecorate(boolean skipDecorate)
void	setSkipPush(boolean skipPush)
void	setSkipTagLatest(boolean skipTagLatest)

Methods inherited from class hudson.tasks.Builder

all, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, prebuild

Methods inherited from class java.lang.Object

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

Constructor Detail

DockerBuilder

@Deprecated
public DockerBuilder(String repoName,
                                 String repoTag,
                                 boolean skipPush,
                                 boolean noCache,
                                 boolean forcePull,
                                 boolean skipBuild,
                                 boolean skipDecorate,
                                 boolean skipTagLatest,
                                 String dockerfilePath)

Deprecated.

DockerBuilder

@DataBoundConstructor
public DockerBuilder(String repoName)

Method Detail

getServer

public org.jenkinsci.plugins.docker.commons.credentials.DockerServerEndpoint getServer()

setServer

@DataBoundSetter
public void setServer(org.jenkinsci.plugins.docker.commons.credentials.DockerServerEndpoint server)

getRegistry

public org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint getRegistry()

setRegistry

@DataBoundSetter
public void setRegistry(org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint registry)

getRepoName

public String getRepoName()

isNoCache

public boolean isNoCache()

setNoCache

@DataBoundSetter
public void setNoCache(boolean noCache)

isForcePull

public boolean isForcePull()

setForcePull

@DataBoundSetter
public void setForcePull(boolean forcePull)

getBuildContext

public String getBuildContext()

setBuildContext

@DataBoundSetter
public void setBuildContext(String buildContext)

getDockerfilePath

public String getDockerfilePath()

setDockerfilePath

@DataBoundSetter
public void setDockerfilePath(String dockerfilePath)

getBuildAdditionalArgs

public String getBuildAdditionalArgs()

setBuildAdditionalArgs

@DataBoundSetter
public void setBuildAdditionalArgs(String buildAdditionalArgs)

isSkipBuild

public boolean isSkipBuild()

setSkipBuild

@DataBoundSetter
public void setSkipBuild(boolean skipBuild)

isSkipDecorate

public boolean isSkipDecorate()

setSkipDecorate

@DataBoundSetter
public void setSkipDecorate(boolean skipDecorate)

getRepoTag

public String getRepoTag()

setRepoTag

@DataBoundSetter
public void setRepoTag(String repoTag)

isSkipPush

public boolean isSkipPush()

setSkipPush

@DataBoundSetter
public void setSkipPush(boolean skipPush)

isSkipTagLatest

public boolean isSkipTagLatest()

setCreateFingerprint

@DataBoundSetter
public void setCreateFingerprint(boolean createFingerprint)

isCreateFingerprint

public boolean isCreateFingerprint()

setSkipTagLatest

@DataBoundSetter
public void setSkipTagLatest(boolean skipTagLatest)

isForceTag

public boolean isForceTag()

setForceTag

@DataBoundSetter
public void setForceTag(boolean forceTag)

getDockerToolName

public String getDockerToolName()

setDockerToolName

@DataBoundSetter
public void setDockerToolName(String dockerToolName)

getRepo

public String getRepo()
               throws IOException

Fully qualified repository/image name with the registry url in front

Returns:

ie. docker.acme.com/jdoe/busybox

Throws:

IOException

perform

public boolean perform(AbstractBuild build,
                       Launcher launcher,
                       BuildListener listener)

Specified by:

perform in interface BuildStep

Overrides:

perform in class BuildStepCompatibilityLayer

getDescriptor

public DockerBuilder.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface Describable<Builder>

Overrides:

getDescriptor in class Builder