Building repositories from GitHub

Stay organized with collections Save and categorize content based on your preferences.

Google Cloud console

To create GitHub triggers using the Google Cloud console, do the following:

1. Open the Triggers page in the Google Cloud console.

   Open the Triggers page

2. Select your Google Cloud project and click Open.

3. Click Create trigger.

4. Enter the following trigger settings:

   • Name: Enter a name for your trigger.

   • Region: Select the region for your trigger.

     • If the build config file associated with the trigger specifies a private pool, then Cloud Build uses the private pool to run your build. In this case, the region you specify in your trigger must match the region where you created your private pool.
     • If the build config file associated with the trigger does not specify a private pool, then Cloud Build uses the default pool to run your build in the same region as your trigger.

   • Description (optional): Enter a description for your trigger.

   • Event: Select the repository event to invoke your trigger.

     • Push to a branch: Set your trigger to start a build on commits to a particular branch.

     • Push new tag: Set your trigger to start a build on commits that contain a particular tag.

     • Pull request: Set your trigger to start a build on commits to a pull request.

   • Source: Configure information about your GitHub repository:

     • Repository service: Select Cloud Build.

     • Repository generation: Select Developer Connect as your source.

     • Repository: From the list of available repositories, select the repository.

     • Branch or Tag: Specify a regular expression with the branch or tag value to match. For information on acceptable regular expression syntax, see RE2 syntax.

     • Comment control: If you selected Pull request as your Event, choose one of the following options to control whether a build is automatically executed by the trigger:

       • Required except for owners and collaborators: When a pull request is created or updated by a repository owner or collaborator, builds are automatically executed by the trigger. If an external contributor initiates the action, builds are executed only after an owner or collaborator comments /gcbrun on the pull request.

       • Required: When a pull request is created or updated by any contributor, builds are executed only after an owner or collaborator comments /gcbrun on the pull request. Builds are executed each time a change to a pull request is made.

       • Not required: When a pull request is created or updated by any contributor, builds are automatically be executed by triggers.

   • Configuration: Select the build config file located in your remote repository or create an inline build config file to use for your build.

     • Type: Select the type of configuration to use for your build.
       • Autodetected: Cloud Build autodetects your configuration type if you have a cloudbuild.yaml or Dockerfile in your repository.
       • Cloud Build configuration file (yaml or json): Use a build config file for your configuration.
       • Dockerfile: Use a Dockerfile for your configuration.
       • Buildpacks: Use buildpacks for your configuration.

     • Location: Specify the location for your configuration.

       • Repository: If your config file is located in your remote repository, provide the location of your build config file or the Dockerfile directory and a name for the resulting image. If your configuration is a Dockerfile, you can optionally provide a timeout for your build. When you've provided the Dockerfile and image name, you'll see a preview of the docker build command that your build will execute.
       • Inline: If you selected Cloud Build configuration file (yaml or json) as your configuration option, you can specify your build config inline. Click Open Editor to write your build config file in the Google Cloud console using YAML or JSON syntax. Click Done to save your build config.

   • Substitution variables (optional): If you selected the Cloud Build config file as your build config option, you can choose to define trigger-specific substitution variables using this field. For example, say you're creating multiple triggers where each trigger deploys your app to a specific environment. You can specify that your app is deployed to an environment in your build config file and then use this field to define substitution variables specifying which environment this trigger should deploy to. For information on specifying substitution values in build config files, see Substituting variable values.

   • Build logs (optional): Check the box to send build logs to GitHub. To learn how to view build logs, see Viewing build logs.

   • Service account: Select the service account to use when invoking your trigger. If your organization policy allows using the legacy Cloud Build service account, you can leave this blank to use the legacy service account. Otherwise, you must select the specific service account to use, even if it's the Compute Engine default service account.

5. Click Create to save your build trigger.

To create GitHub triggers using gcloud commands, see the gcloud commands for Creating a build trigger.

gcloud CLI

To create GitHub triggers using gcloud commands, run the following command:

    gcloud alpha builds triggers create developer connect
      --name=TRIGGER_NAME \
      --git-repository-link=projects/PROJECT_ID/locations/REGION/connections/CONNECTION_NAME/gitRepositoryLinks/REPO_NAME \
      --branch-pattern=BRANCH_PATTERN # or --tag-pattern=TAG_PATTERN \
      --build-config=BUILD_CONFIG_FILE \
      --region=REGION \
      --service-account=SERVICE-ACCOUNT

Where:

• TRIGGER_NAME is the name of your trigger.
• PROJECT_ID is your Google Cloud project ID.
• REGION is the region of your trigger.
• CONNECTION_NAME is the name of your GitHub connection.
• GIT_REPOSITORY_LINK is the link to your Git repository.
• BRANCH_PATTERN is the branch name in your repository to invoke the build on.
• TAG_PATTERN is the tag name in your repository to invoke the build on.
• BUILD_CONFIG_FILE is the path to your build configuration file.
• SERVICE-ACCOUNT is the service account to use for trigger and build operations.

API

To create a GitHub trigger with the API, use the following JSON template:

  {
      "filename": "cloudbuild.yaml",
      "name": "TRIGGER_NAME",
      "description": "TRIGGER_DESCRIPTION",
      "serviceAccount": "SERVICE_ACCOUNT",
      "github": {
          "owner": "OWNER",
          "name": "REPO_NAME",
          "push": {
              "branch": ".*"
          },
      
      },
      "include_build_logs": include-build-logs-value
  }

Where:

• TRIGGER_NAME is a name for the trigger.
• TRIGGER_DESCRIPTION is a description for the trigger.
• SERVICE_ACCOUNT is the service account to use for trigger and build operations.
• OWNER is the owner of the GitHub repository.
• REPO_NAME is the name of the GitHub repository.
• include-build-logs-value is the value of the optional include_build_logs field. If this field has a value of INCLUDE_BUILD_LOGS_SPECIFIED, then build logs are shown on your repository.

Enter the following curl command in your terminal:

curl -X POST -H "Authorization: Bearer "$(gcloud auth print-access-token) -H "Content-Type: application/json; charset=utf-8" -H "x-goog-user-project: PROJECT_NUMBER" https://cloudbuild.googleapis.com/v1/projects/PROJECT_ID/triggers -d @trigger.json

Where:

• PROJECT_NUMBER is your Google Cloud project number.
• PROJECT_ID is your Google Cloud project ID.