README.md

Cloud Build - GitHub Actions

An example workflow that uses GitHub Actions to build a Hello World Node.js app container image using Cloud Build.

This code is intended to be an example. You will likely need to change or update values to match your setup.

Workflow description

For pushes to the main branch, this workflow will:

1. Download and configure the Google Cloud SDK with the provided credentials.

2. Build, tag, and push a container image to Google Container Registry.

   • The image is built using Cloud Build and pushed to Google Container Registry.

   • The image is available through the following tags: latest and first 8 of the commit SHA.

Setup

1. Create a new Google Cloud Project (or select an existing project) and enable the Cloud Build and Cloud Build APIs.

2. Create or reuse a GitHub repository for the example workflow:

   1. Create a repository.

   2. Move into the repository directory:

      $ cd <repo>
      

   3. Copy the example into the repository:

      $ cp -r <path_to>/github-actions/example-workflows/cloud-build/ .
      

3. Create a Google Cloud service account if one does not already exist.

4. Add the following Cloud IAM roles to your service account:

   • Cloud Build Service Account - allows for execution of builds on your behalf

   • Viewer - allows for Cloud Build log storage

5. Create a JSON service account key for the service account.

6. Add the following secrets to your repository's secrets:

   • RUN_PROJECT: Google Cloud project ID

   • RUN_SA_EMAIL: the email of the service account

   • RUN_SA_KEY: the content of the service account JSON file

Run the workflow

1. Add and commit your changes:

   $ git add .
   $ git commit -m "Set up GitHub workflow"
   

2. Push to the main branch:

   $ git push -u origin main
   

3. View the GitHub Actions Workflow by selecting the Actions tab at the top of your repository on GitHub. Then click on the Build using Cloud Build element to see the details.