package
0.9.0
Repository: https://github.com/jszwedko/docker-builder.git
Documentation: pkg.go.dev

# Functions

IsSanitizeError returns true if the error provided is of the type SanitizeError.
IsSanitizeFileNotExist returns true if the error provided is a SanitizeError resulting from an "os" IsNotExist PathError.
NewBuilder returns an instance of a Builder struct.
NewTrustedFilePath returns struct representation of the path to a file.
SanitizeTrustedFilePath checks for disallowed entries in the provided file path and returns either a sanitized version of the path or an error.

# Constants

DoesNotExistSanitizeErrorMessage is the error message used in cases where the error results in the requested file not existing.
DotDotSanitizeErrorMessage is the error message used in errors that occur because a provided Bobfile path contains "..".
InvalidPathSanitizeErrorMessage is the error message used in errors that occur because a provided Bobfile path is invalid.
SymlinkSanitizeErrorMessage is the error message used in errors that occur because a provided Bobfile path contains symlinks.

# Variables

SkipPush will, when set to true, override any behavior set by a Bobfile and will cause builders *NOT* to run `docker push` commands.

# Structs

A Builder is the struct that actually does the work of moving files around and executing the commands that do the docker build.
BuildRelatedError is used for build-related errors produced by the builder package that are encountered during the build process.
ParserRelatedError is used for errors encounted during the building process that are related to parsing the Bobfile.
SanitizeError is used for errors related to sanitizing a given Bobfile path.
TrustedFilePath contains the fields of a path to a file including "top", the top level directory containing the file, and "file", the relative path from top to the file.

# Interfaces

Error is an interface for any error types returned by the builder package / during the building process.