com.google.cloud.tools.jib.frontend

Class BuildStepsRunner

java.lang.Object

com.google.cloud.tools.jib.frontend.BuildStepsRunner

public class BuildStepsRunner
extends java.lang.Object

Runs a BuildSteps and builds helpful error messages.

Method Summary

Modifier and Type	Method and Description
void	build(HelpfulSuggestions helpfulSuggestions) Runs the BuildSteps.
static BuildStepsRunner	forBuildImage(BuildConfiguration buildConfiguration) Creates a runner to build an image.
static BuildStepsRunner	forBuildTar(java.nio.file.Path outputPath, BuildConfiguration buildConfiguration) Creates a runner to build an image tarball.
static BuildStepsRunner	forBuildToDockerDaemon(BuildConfiguration buildConfiguration) Creates a runner to build to the Docker daemon.

Methods inherited from class java.lang.Object

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

Method Detail

forBuildImage

public static BuildStepsRunner forBuildImage(BuildConfiguration buildConfiguration)
                                      throws CacheDirectoryCreationException

Creates a runner to build an image. Creates a directory for the cache, if needed.

Parameters:

buildConfiguration - the configuration parameters for the build

Returns:

a BuildStepsRunner for building to a registry

Throws:

CacheDirectoryCreationException - if the cacheDirectory could not be created

forBuildToDockerDaemon

public static BuildStepsRunner forBuildToDockerDaemon(BuildConfiguration buildConfiguration)
                                               throws CacheDirectoryCreationException

Creates a runner to build to the Docker daemon. Creates a directory for the cache, if needed.

Parameters:

buildConfiguration - the configuration parameters for the build

Returns:

a BuildStepsRunner for building to a Docker daemon

Throws:

CacheDirectoryCreationException - if the cacheDirectory could not be created

forBuildTar

public static BuildStepsRunner forBuildTar(java.nio.file.Path outputPath,
                                           BuildConfiguration buildConfiguration)
                                    throws CacheDirectoryCreationException

Creates a runner to build an image tarball. Creates a directory for the cache, if needed.

Parameters:

outputPath - the path to output the tarball to

buildConfiguration - the configuration parameters for the build

Returns:

a BuildStepsRunner for building a tarball

Throws:

CacheDirectoryCreationException - if the cacheDirectory could not be created

build

public void build(HelpfulSuggestions helpfulSuggestions)
           throws BuildStepsExecutionException

Runs the BuildSteps.

Parameters:

helpfulSuggestions - suggestions to use in help messages for exceptions

Throws:

BuildStepsExecutionException - if another exception is thrown during the build