Storing build artifacts in Cloud Storage

This page explains how you can store build artifacts in Cloud Storage.

We recommend using Artifact Registry for storing build artifacts. Artifact Registry is a Google Cloud product that you can integrate with Cloud Build to securely store and manage your artifacts in private or public repositories. Storing artifacts in Artifact Registry enables you to:

For instructions on configuring Cloud Build to store packages and images from your builds in Artifact Registry, see Store artifacts in Artifact Registry.

Storing artifacts in Cloud Storage

To store non-container artifacts in Cloud Storage, add an artifacts field in your build config file with the location of the bucket to store the artifact and the path to one or more artifacts:

YAML 

artifacts:
  objects:
    location: [STORAGE_LOCATION]
    paths: [[ARTIFACT_PATH],[ARTIFACT_PATH], ...]

Where,

  • [STORAGE_LOCATION]: A Cloud Storage bucket or a folder within the bucket where Cloud Build must store the artifact, such as gs://mybucket or gs://mybucket/myproject/builds. To find the names of existing buckets, see list buckets or create a new bucket.
  • [ARTIFACT_PATH]: Path to one or more artifacts. [ARTIFACT_PATH] is relative to your working directory. This can be either /workspace, which is Cloud Build's default working directory or the working directory you set using the dir field.

JSON 

{
    "artifacts": {
        "objects": {
            "location": [
                "[STORAGE_LOCATION]"
            ],
            "paths": [
            [
                "[ARTIFACT_PATH]"
            ],
            [
                "[ARTIFACT_PATH]"
            ],
            "..."
            ]
        }
    }
}

Where,

  • [STORAGE_LOCATION]: A Cloud Storage bucket or a folder within the bucket where Cloud Build must store the artifact, such as gs://mybucket or gs://mybucket/myproject/builds. To find the names of existing buckets, see list buckets or create a new bucket.
  • [ARTIFACT_PATH]: Path to one or more artifacts. [ARTIFACT_PATH] is relative to your working directory. This can be either /workspace, which is Cloud Build's default working directory or the working directory you set using the dir field.

Note the following caveats when storing artifacts in Cloud Storage:

  • You can specify only one bucket to upload the artifacts and you must be the owner of the bucket. You can specify a valid directory path in the bucket.

  • You can upload any number of artifacts, but you can specify only up to one hundred artifact paths.

  • If you upload an artifact to a bucket that already has an artifact with the same name, the new artifact will replace the existing artifact. You can enable Object Versioning for your bucket if you don't want the newer artifact to replace an existing artifact with the same name.

After the build completes successfully, you can find the upload results in the JSON manifest file located at [STORAGE_LOCATION]/artifacts-$BUILD_ID.json.

The JSON manifest file has the following fields:

  • location: this specifies the location in Cloud Storage where an artifact is stored and is of the form gs://[STORAGE_LOCATION]/[FILE_NAME]#[GENERATION_NUMBER]. You can use the generation number to uniquely identify a version of the data in Cloud Storage bucket.
  • file_hash: this specifies the hash type and the value. The hash type is always 2, which specifies that MD5 hash was performed.

Artifacts examples

The following examples show how you can use the Artifacts field in a build config file. In all of these examples replace [VALUES_IN_BRACKETS] with the appropriate values.

Uploading files and folders

The build config file below uploads helloworld.class to thegs://[STORAGE_LOCATION]/:

YAML 

steps:
- name: 'gcr.io/cloud-builders/javac'
  args: ['HelloWorld.java']
artifacts:
  objects:
    location: 'gs://[STORAGE_LOCATION]/'
    paths: ['HelloWorld.class']

JSON 

{
    "steps": [
    {
        "name": "gcr.io/cloud-builders/javac",
        "args": [
            "HelloWorld.java"
        ]
    }
    ],
    "artifacts": {
        "objects": {
            "location": "gs://[STORAGE_LOCATION]/",
            "paths": [
                "HelloWorld.class"
            ]
        }
    }
}

To upload more than one artifact, specify the path to each artifact separated by a comma. The following example uploads HelloWorld.java, HelloWorld.class, and cloudbuild.yaml to gs://[STORAGE_LOCATION]/:

YAML 

steps:
- name: 'gcr.io/cloud-builders/javac'
  args: ['HelloWorld.java']
artifacts:
  objects:
    location: 'gs://[STORAGE_LOCATION]/'
    paths: ['HelloWorld.java', 'HelloWorld.class', 'cloudbuild.yaml']

JSON 

{
    "steps": [
    {
        "name": "gcr.io/cloud-builders/javac",
        "args": [
            "HelloWorld.java"
        ]
    }
    ],
    "artifacts": {
        "objects": {
            "location": "gs://[STORAGE_LOCATION]/",
            "paths": [
                "HelloWorld.java",
                "HelloWorld.class",
                "cloudbuild.yaml"
            ]
        }
    }
}

You can also upload the artifacts to a valid directory path in the bucket. The following example uploads HelloWorld.java and HelloWorld.class to gs://[BUCKET_NAME]/[FOLDER_NAME]:

YAML 

steps:
- name: 'gcr.io/cloud-builders/javac'
  args: ['HelloWorld.java']
artifacts:
  objects:
    location: 'gs://[BUCKET_NAME]/[FOLDER_NAME]'
    paths: ['HelloWorld.java', 'HelloWorld.class']

JSON 

{
    "steps": [
    {
        "name": "gcr.io/cloud-builders/javac",
        "args": [
            "HelloWorld.java"
        ]
    }
    ],
    "artifacts": {
        "objects": {
            "location": "gs://[BUCKET_NAME]/[FOLDER_NAME]",
            "paths": [
                "HelloWorld.java",
                "HelloWorld.class"
            ]
        }
    }
}

Using wildcard characters to upload more than one artifact

When uploading multiple artifacts, you can use gsutil wildcard characters in paths to specify multiple files.

The following example takes as an argument a file named classes, which contains the names of the .java files to compile. It then uploads any .class file to the specified Cloud Storage bucket:

YAML

steps:
- name: 'gcr.io/cloud-builders/javac'
  args: ['@classes']
artifacts:
  objects:
    location: 'gs://[STORAGE_LOCATION]/'
    paths: ['*.class']

JSON 

{
    "steps": [
    {
        "name": "gcr.io/cloud-builders/javac",
        "args": [
            "@classes"
        ]
    }
    ],
    "artifacts": {
        "objects": {
            "location": "gs://[STORAGE_LOCATION]/",
            "paths": [
                "*.class"
            ]
        }
    }
}

Using substitution variables in the bucket location

You can use substitution variables to specify a folder within the Cloud Storage bucket. If the folder you've specified doesn't exist, Cloud Build will create it for you.

The example below uploads the artifacts to a Cloud Storage path that includes the name of your Google Cloud project from which the build was run (such as gs://mybucket/myproject/):

YAML 

steps:
- name: 'gcr.io/cloud-builders/javac'
  args: ['@classes']
artifacts:
  objects:
    location: 'gs://[BUCKET_NAME]/$PROJECT_ID'
    paths: ['helloworld.class']

JSON 

{
    "steps": [
    {
        "name": "gcr.io/cloud-builders/javac",
        "args": [
            "@classes"
        ]
    }
    ],
    "artifacts": {
        "objects": {
            "location": "gs://[BUCKET_NAME]/$PROJECT_ID",
            "paths": [
                "helloworld.class"
            ]
        }
    }
}

What's next