Documentation
¶
Index ¶
- Constants
- Variables
- func DigestReference(ref string) bool
- func DockerInitPath(localCopy string) string
- func ExperimentalBuild() bool
- func GetCallerName(depth int) string
- func GetErrorMessage(err error) string
- func GitClone(remoteURL string) (string, error)
- func ImageReference(repo, ref string) string
- func IsTimeout(err error) bool
- func ReadDockerIgnore(reader io.ReadCloser) ([]string, error)
- func ReplaceOrAppendEnvValues(defaults, overrides []string) []string
- func SelfPath() string
- func TestDirectory(templateDir string) (dir string, err error)
- func ValidateContextDirectory(srcPath string, excludes []string) error
Constants ¶
const RestrictedNameChars = `[a-zA-Z0-9][a-zA-Z0-9_.-]`
RestrictedNameChars collects the characters allowed to represent a name, normally used to validate container and volume names.
Variables ¶
var RestrictedNamePattern = regexp.MustCompile(`^/?` + RestrictedNameChars + `+$`)
RestrictedNamePattern is a regular expression to validate names against the collection of restricted characters.
Functions ¶
func DigestReference ¶
DigestReference returns true if ref is a digest reference; i.e. if it is of the form <algorithm>:<digest>.
func DockerInitPath ¶
DockerInitPath figures out the path of our dockerinit (which may be SelfPath())
func ExperimentalBuild ¶
func ExperimentalBuild() bool
ExperimentalBuild is a stub which always returns false for builds that do not include the "experimental" build tag
func GetCallerName ¶
GetCallerName introspects the call stack and returns the name of the function `depth` levels down in the stack.
func GetErrorMessage ¶
GetErrorMessage returns the human readable message associated with the passed-in error. In some cases the default Error() func returns something that is less than useful so based on its types this func will go and get a better piece of text.
func GitClone ¶
GitClone clones a repository into a newly created directory which will be under "docker-build-git"
func ImageReference ¶
ImageReference combines `repo` and `ref` and returns a string representing the combination. If `ref` is a digest (meaning it's of the form <algorithm>:<digest>, the returned string is <repo>@<ref>. Otherwise, ref is assumed to be a tag, and the returned string is <repo>:<tag>.
func IsTimeout ¶
IsTimeout takes an error returned from (generally) the http package and determines if it is a timeout error.
func ReadDockerIgnore ¶
func ReadDockerIgnore(reader io.ReadCloser) ([]string, error)
ReadDockerIgnore reads a .dockerignore file and returns the list of file patterns to ignore. Note this will trim whitespace from each line as well as use GO's "clean" func to get the shortest/cleanest path for each.
func ReplaceOrAppendEnvValues ¶
ReplaceOrAppendEnvValues returns the defaults with the overrides either replaced by env key or appended to the list
func SelfPath ¶
func SelfPath() string
SelfPath figures out the absolute path of our own binary (if it's still around).
func TestDirectory ¶
TestDirectory creates a new temporary directory and returns its path. The contents of directory at path `templateDir` is copied into the new directory.
func ValidateContextDirectory ¶
ValidateContextDirectory checks if all the contents of the directory can be read and returns an error if some files can't be read symlinks which point to non-existing files don't trigger an error
Types ¶
This section is empty.
Source Files