Google Cloud Build

Warnings

• gotcha Application Default Credentials (ADC) is the recommended authentication method. Avoid hardcoding service account key files in your code, especially in production environments. Use `gcloud auth application-default login` for local development or rely on attached service accounts for GCP deployments.
  Fix: Use `gcloud auth application-default login` for local setup. For GCP deployments (e.g., Cloud Run, GKE, Cloud Functions), ensure your service account has the necessary IAM roles (e.g., Cloud Build Editor or custom roles) and rely on ADC to automatically pick up credentials.
• breaking Cloud Build has undergone changes to how it uses service accounts for new projects and the handling of the 'Service Account User' role. This might impact permission configurations, requiring explicit configuration for service account impersonation for managed services.
  Fix: Review the Cloud Build release notes and official documentation regarding service account changes. Ensure your Cloud Build service account has appropriate permissions and is configured for impersonation if deploying to managed services. For new projects, verify the default service account behavior.
• gotcha Build steps in Cloud Build have a default timeout of 10 minutes. Long-running operations may fail with a 'Step exceeded maximum allowed runtime' error if this limit is reached.
  Fix: For build steps that are expected to take longer, explicitly set the `timeout` field in your `cloudbuild.yaml` for that specific step or for the entire build.
• gotcha The logging events from `google-cloud-build` (and other Google Cloud Python client libraries) may contain sensitive information, and their occurrence, level, and content can change without being flagged as a breaking change.
  Fix: Exercise caution when saving or exposing logs. Do not depend on the immutability of logging events for programmatic parsing. Configure log handling explicitly if you need to capture and process logs.

Install

• pip install google-cloud-build Install with pip

Imports

• CloudBuildClient

  from google.cloud import build_v1
  client = build_v1.CloudBuildClient()

Quickstart

This quickstart initializes the Cloud Build client and lists recent builds for a specified Google Cloud project. Ensure the `GOOGLE_CLOUD_PROJECT` environment variable is set or replace 'your-gcp-project-id' with your project ID. The Cloud Build API must be enabled, and your credentials must have the `cloudbuild.builds.list` permission.

import os
from google.cloud import build_v1
from google.api_core.exceptions import GoogleAPIError

project_id = os.environ.get('GOOGLE_CLOUD_PROJECT', 'your-gcp-project-id')

try:
    # Initialize the Cloud Build client
    client = build_v1.CloudBuildClient()

    # List recent builds for the specified project
    print(f"Listing recent builds for project: {project_id}")
    request = build_v1.ListBuildsRequest(project_id=project_id)
    builds = client.list_builds(request=request)

    if not builds.builds:
        print("No builds found.")
    else:
        for build in builds.builds:
            print(f"  Build ID: {build.id}, Status: {build.status.name}, Create Time: {build.create_time.isoformat()}")

except GoogleAPIError as e:
    print(f"An API error occurred: {e}")
    print("Please ensure the Cloud Build API is enabled and your credentials have sufficient permissions.")
except Exception as e:
    print(f"An unexpected error occurred: {e}")