constants

Documentation

Index

• Constants

Constants

const (
	// ObfuscationString is the string is used to hide sensitive data such as token in logs
	ObfuscationString = "*************"

	// TimestampFormat is the common timestamp format ACR Builder uses
	TimestampFormat = time.RFC3339

	// DefaultDockerfile is the name of the default dockerfile
	DefaultDockerfile = "Dockerfile"

	// SourceNameWebArchive is the name of the web archive source
	SourceNameWebArchive = "web archive"

	// SourceNameGit is the name of the git source
	SourceNameGit = "git repository"

	// SourceNameLocal is the name of local source
	SourceNameLocal = "local directory"

	// DependencyTypeBuild denotes build time dependency
	DependencyTypeBuild = "build"

	// DependencyTypeRuntime denotes runtime dependency
	DependencyTypeRuntime = "runtime"

	// NoBaseImageSpecifierLatest is the symbol used by the FROM
	// command to specify that no base image is to be used.
	// Note that :latest is not valid in the FROM clause, but we're
	// always appending :latest to tags during processing.
	NoBaseImageSpecifierLatest = "scratch:latest"
)

const (

	// ExportsWorkingDir is the variable name for checkout dir
	ExportsWorkingDir = acrBuildPrefix + "WORKING_DIR"

	// ExportsDockerfilePath is the variable name for docker file path
	ExportsDockerfilePath = dockerDomainPrefix + "FILE"

	// ExportsDockerBuildContext is the docker build context directory
	ExportsDockerBuildContext = dockerDomainPrefix + "CONTEXT"

	// ExportsDockerRegistry is the docker registry to push to
	ExportsDockerRegistry = dockerDomainPrefix + "REGISTRY"

	// ExportsGitSource is the current git source URL
	ExportsGitSource = gitDomainPrefix + "SOURCE"

	// ExportsGitBranch is current git branch
	ExportsGitBranch = gitDomainPrefix + "BRANCH"

	// ExportsGitHeadRev is the current git head revision
	ExportsGitHeadRev = gitDomainPrefix + "HEAD_REV"

	// ExportsGitAuthType is the git authentication type used
	ExportsGitAuthType = gitDomainPrefix + "AUTH_TYPE"

	// ExportsGitUser is the current git user
	ExportsGitUser = gitDomainPrefix + "USER"

	// ExportsPushOnSuccess is the boolean value denoting whether the build will push on success
	ExportsPushOnSuccess = acrBuildPrefix + "PUSH_ON_SUCCESS"

	// ExportsBuildNumber is the current build number
	ExportsBuildNumber = acrBuildPrefix + "NUMBER"

	// ExportsBuildTimestamp is the timestamp when the build started in ISO format
	ExportsBuildTimestamp = acrBuildPrefix + "TIMESTAMP"
)

const (
	// ArgNameBuildNumber is the parameter name for build number
	ArgNameBuildNumber = "build-number"

	//ArgNameWorkingDir is the parameter name for the git clone target directory
	ArgNameWorkingDir = "working-dir"

	// ArgNameGitURL is the parameter name for git URL
	ArgNameGitURL = "git-url"

	// ArgNameGitBranch is the parameter name for git branch
	ArgNameGitBranch = "git-branch"

	// ArgNameGitHeadRev is the parameter name for head revision
	ArgNameGitHeadRev = "git-head-revision"

	// ArgNameGitPATokenUser is the parameter name for username for git username
	ArgNameGitPATokenUser = "git-username"

	// ArgNameGitPAToken is the parameter name for git password
	ArgNameGitPAToken = "git-password"

	// ArgNameGitXToken is the parameter name for github x-oath-basic token
	ArgNameGitXToken = "git-x-token"

	// ArgNameWebArchive is the parameter name for web archives
	ArgNameWebArchive = "archive"

	// ArgNameDockerfile is the parameter name for dockerfile
	ArgNameDockerfile = "docker-file"

	// ArgNameDockerImage is the parameter name for docker image (registry url must be excluded from the image name parameter)
	ArgNameDockerImage = "t"

	// ArgNameDockerContextDir is the parameter name for docker context directory
	ArgNameDockerContextDir = "docker-context-dir"

	// ArgNameDockerRegistry is the parameter name for docker registry to push to
	ArgNameDockerRegistry = "docker-registry"

	// ArgNameDockerUser is the parameter name for docker username used for pushing
	ArgNameDockerUser = "docker-user"

	// ArgNameDockerPW is the parameter name for docker password used for pushing
	ArgNameDockerPW = "docker-password"

	// ArgNameDockerBuildArg is the parameter name for build args passed in to docker. This parameter is repeatable.
	ArgNameDockerBuildArg = "docker-build-arg"

	// ArgNameDockerSecretBuildArg is the parameter name for build args passed in to docker. The argument value contains a secret which will be hidden from the log. This parameter is repeatable.
	ArgNameDockerSecretBuildArg = "docker-secret-build-arg"

	// ArgNameBuildEnv is the parameter name for build environment variables to be set. This parameter is repeatable
	ArgNameBuildEnv = "build-env"

	// ArgNamePull is the parameter determining if attempting to pull a newer version of the base images. Default: false
	ArgNamePull = "pull"

	// ArgNameNoCache is the parameter determining if not using any cached layer when building the image. Default: false
	ArgNameNoCache = "no-cache"

	// ArgNamePush is the parameter determining whether or not push should occur if the build would succeed. Default: false
	ArgNamePush = "push"

	// ArgNameDebug is the parameter that enables debug logs
	ArgNameDebug = "verbose"
)

const (
	// GeneralErrorExitCode is a catchall for general errors.
	GeneralErrorExitCode = 1
)