Google Cloud Build configuration file Json Format

Use this form to visualize Google Cloud Build configuration file.

logsBucket - Google Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.

steps Required. The operations to be performed on the workspace.

#	name	entrypoint	timeout	id	dir	Actions
{{$index+1}}.	{{row.name}}	{{row.entrypoint}}	{{row.timeout}}	{{row.id}}	{{row.dir}}

tags Tags for annotation of a `Build`. These are not docker tags.

#	Values	Actions
{{$index+1}}.

.substitutions

_

images A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`.

#	Values	Actions
{{$index+1}}.

.options

_

options.machineType - Compute Engine machine type on which to run the build.

options.logStreamingOption - Option to define build log streaming behavior to Google Cloud Storage.

options.workerPool - Option to specify a `WorkerPool` for the build. User specifies the pool with the format "[WORKERPOOL_PROJECT_ID]/[WORKERPOOL_NAME]". This is an experimental field.

options.logging - Option to specify the logging mode, which determines where the logs are stored.

options.requestedVerifyOption - Requested verifiability options.

options.substitutionOption - Option to specify behavior when there is an error in the substitution checks.

options.diskSizeGb - Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 1000GB; builds that request more than the maximum are rejected with an error.

options.volumes Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration.

#	name	path	Actions
{{$index+1}}.

options.env A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".

#	Values	Actions
{{$index+1}}.

options.secretEnv A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. These variables will be available to all build steps in this build.

#	Values	Actions
{{$index+1}}.

options.sourceProvenanceHash Requested hash for SourceProvenance.

#	Values	Actions
{{$index+1}}.

.source

_

.source.storageSource

_

source.storageSource.generation - Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.

source.storageSource.bucket - Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).

source.storageSource.object - Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build.

.source.repoSource

_

source.repoSource.tagName - Name of the tag to build.

source.repoSource.projectId - ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.

source.repoSource.repoName - Name of the Cloud Source Repository. If omitted, the name "default" is assumed.

source.repoSource.commitSha - Explicit commit SHA to build.

source.repoSource.dir - Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution.

source.repoSource.branchName - Name of the branch to build.

.artifacts

_

.artifacts.objects

_

artifacts.objects.location - Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix.

timeout - Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. Default time is ten minutes.

artifacts.objects.paths Path globs used to match files in the build's workspace.

#	Values	Actions
{{$index+1}}.

artifacts.images A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE.

#	Values	Actions
{{$index+1}}.

secrets Secrets to decrypt using Cloud Key Management Service.

#	kmsKeyName	Actions
{{$index+1}}.

name - Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step.

entrypoint - Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.

timeout - Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.

id - Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency.

dir - Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution.

waitFor The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully.

#	Values	Actions
{{$index+1}}.

env A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".

#	Values	Actions
{{$index+1}}.

volumes List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration.

#	name	path	Actions
{{$index+1}}.

args A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.

#	Values	Actions
{{$index+1}}.

secretEnv A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`.

#	Values	Actions
{{$index+1}}.

.secretEnv

ToolMatter

Your Apps in Action

Use this form to visualize Google Cloud Build configuration file.

{{repoTitle.MainEntity}}

steps Required. The operations to be performed on the workspace.

tags Tags for annotation of a `Build`. These are not docker tags.

_

_

options.secretEnv A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. These variables will be available to all build steps in this build.

options.sourceProvenanceHash Requested hash for SourceProvenance.

_

_

_

_

_

artifacts.objects.paths Path globs used to match files in the build's workspace.

secrets Secrets to decrypt using Cloud Key Management Service.

{{repoTitle.MainEntity}}

env A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".

secretEnv A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`.

{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}

_secrets