Formatter Validator Minifier Escape / Unescape JSON ↔ String JSON ↔ YAML JSON → CSV NDJSON / JSON Lines JSON → Types JSON ↔ XML JSON Diff JSON Patch Canonicalize (RFC 8785) Schema Validator Schema Generator JSONPath Tester JWT Decoder JSON Errors Schemas More Tools
JSONTools / Schema registry / cloudbuild.json
Schema registry

cloudbuild.json

Google Cloud Build configuration file

cloudbuild.jsoncloudbuild.yamlcloudbuild.yml*.cloudbuild.json*.cloudbuild.yaml*.cloudbuild.yml
Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your cloudbuild.json and it validates in your browser — nothing is uploaded.

Validate a cloudbuild.json → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field Type Description
stepsrequiredarrayRequired. The operations to be performed on the workspace.
logsBucketstringGoogle Cloud Storage bucket where logs should be written. Logs file names will be of the format ${logs_bucket}/log-${build_id}.txt.
tagsarray<string>Tags for organizing and filtering builds.
substitutionsobjectSubstitutions data for Build resource.
imagesarray<string>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
optionsobjectOptional arguments to enable specific features of builds.
options.automapSubstitutionsbooleanIf set to true, automatically map all subsistutions and make them available as environment variables in a single step. If set to false, ignore substitutions for that step. Can be used for a build step or for an entire build.
options.machineTypestringCompute Engine machine type on which to run the build.
default: "UNSPECIFIED"
one of: "E2_HIGHCPU_8", "E2_HIGHCPU_32", "E2_MEDIUM", "N1_HIGHCPU_8", "N1_HIGHCPU_32", "UNSPECIFIED"
options.volumesarrayGlobal 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
options.logStreamingOptionstringOption to define build log streaming behavior to Google Cloud Storage.
one of: "STREAM_DEFAULT", "STREAM_ON", "STREAM_OFF"
options.poolobjectSet the value of this field to the resource name of the private pool to run the build.
options.pool.namerequiredstringRequired. The full resource name of the private pool of the form 'projects/$PRIVATEPOOL_PROJECT_ID/locations/$REGION/workerPools/$PRIVATEPOOL_ID'.
options.envarray<string>A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined both globally and in a build step, the variable will use the build step value. The elements are of the form
options.loggingstringOption to specify the logging mode, which determines where the logs are stored.
one of: "LOGGING_UNSPECIFI…, "LEGACY", "GCS_ONLY", "CLOUD_LOGGING_ONL…, "NONE"
options.defaultLogsBucketBehaviorstringConfigure Cloud Build to create a default logs bucket within your own project in the same region as your build.
one of: "DEFAULT_LOGS_BUCK…, "REGIONAL_USER_OWN…
options.requestedVerifyOptionstringRequested verifiability options.
one of: "NOT_VERIFIED", "VERIFIED"
options.substitutionOptionstringOption to specify behavior when there is an error in the substitution checks.
one of: "MUST_MATCH", "ALLOW_LOOSE"
options.dynamicSubstitutionsbooleanUse this option to explicitly enable or disable bash parameter expansion in substitutions. If your build is invoked by a trigger, the dynamicSubstitutions field is always set to true and does not need to be specified in your build config
options.diskSizeGboneOfRequested 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
options.secretEnvarray<string>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.sourceProvenanceHasharray<string>Requested hash for SourceProvenance.
artifactsobjectArtifacts produced by a build that should be uploaded upon successful completion of all build steps.
artifacts.objectsobjectFiles in the workspace to upload to Cloud Storage upon successful completion of all build steps.
artifacts.objects.locationstringCloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix.
artifacts.objects.pathsarray<string>Path globs used to match files in the build's workspace.
artifacts.goModulesarrayAllows you to upload non-container Go modules to Go repositories in Artifact Registry.
artifacts.mavenArtifactsarrayAllows you to upload non-container Java artifacts to Maven repositories in Artifact Registry.
artifacts.pythonPackagesarrayAllows you to upload Python packages to Artifact Registry.
artifacts.npmPackagesarrayUploads your built NPM packages to supported repositories.
timeoutstringTime limit for executing the build or particular build step. The timeout field of a build step specifies the amount of time the step is allowed to run, and the timeout field of a build specifies the amount of time the build is allowed to
secretsarraySecrets to decrypt using Cloud Key Management Service.
serviceAccountstringUse this field to specify the IAM service account to use at build time.
queueTtlstringSpecifies the amount of time a build can be queued. If a build is in the queue for longer than the value set in queueTtl, the build expires and the build status is set to EXPIRED.
default: "3600s"
Audit

What we found in this schema

Standards

Specification sections for the keywords in this schema

Keyword Document Section
$commentJSON Schema Core, draft 2020-12§8.3 — Comments With "$comment"
$idJSON Schema Core, draft 2020-12§8.2.1 — The "$id" Keyword
$refJSON Schema Core, draft 2020-12§8.2.3.1 — Direct References with "$ref"
$schemaJSON Schema Core, draft 2020-12§8.1.1 — "$schema"
additionalPropertiesJSON Schema Core, draft 2020-12§10.3.2.3 — "additionalProperties"
defaultJSON Schema Validation, draft 2020-12§9.2 — "default"
descriptionJSON Schema Validation, draft 2020-12§9.1 — "title" and "description"
enumJSON Schema Validation, draft 2020-12§6.1.2 — "enum"
examplesJSON Schema Validation, draft 2020-12§9.5 — "examples"
itemsJSON Schema Core, draft 2020-12§10.3.1.2 — "items"
patternJSON Schema Validation, draft 2020-12§6.3.3 — "pattern"
propertiesJSON Schema Core, draft 2020-12§10.3.2.1 — "properties"
requiredJSON Schema Validation, draft 2020-12§6.5.3 — "required"
typeJSON Schema Validation, draft 2020-12§6.1.1 — "type"

Documents

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas