Google Cloud console

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

1. Open theTriggers page in the Google Cloud console.

   Open the Triggers page

2. Select your Google Cloud project and clickOpen.

3. ClickCreate trigger.

4. Enter the following trigger settings:

   • Name: Enter a name for your trigger.

   • Region: Select theregion for your trigger.

     • If the build config file associated with the trigger specifies aprivate pool, thenCloud Build uses the private pool to run your build. In thiscase, the region you specify in your trigger must match the regionwhere you created your private pool.
     • If the build config file associated with the triggerdoesn'tspecify a private pool, then Cloud Build uses the defaultpool 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 toa particular branch.

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

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

       Note: Running builds initiated by a GitHub App pull request triggerare canceled when you close the pull request associated withyour build. Running builds and builds that have not been startedyet won't be canceled when merging a pull request.

   • Source: Configure information about your GitHub repository:

     • Repository service: Select Cloud Build.

     • Repository generation: Select1st generation as your source.

     Note: The region of your repository must matchthe region of your trigger.

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

     • Branch orTag: Specify a regular expression with the branch ortag value to match. For information on acceptable regular expression syntax,seeRE2 syntax.

     • Comment control: If you selectedPull requestas yourEvent, choose one of the following options tocontrol whether a build is automatically executed by the trigger:

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

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

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

     Warning: Any user with read access to the repository can submit apull request, which may execute a build that includes changes to thesource code in the pull request. To disable this behavior, werecommend usingmanual approvalsto gate builds when making pull requests on public repositories.You can also learn more about thebuild-time privileges of triggers.

   • Configuration: Select the build config file located inyour remote repository or create an inline build config file touse for your build.

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

     • Location: Specify the location for your configuration.

       • Repository: If your config file is located in yourremote repository, provide the location of yourbuild config file or theDockerfiledirectory and a name for the resulting image. If your configurationis aDockerfile, you can optionally provide a timeout for your build.When you've provided theDockerfile and image name, you'll see apreview of thedocker build command that your build will execute.
       • Inline: If you selectedCloud Build configuration file (yaml or json) asyour configuration option, you can specify your build configinline. ClickOpen Editor to write your build config file in theGoogle Cloud console using YAML or JSON syntax. ClickDone tosave your build config.
       Note: Inline build configuration support is not availableforDockerfile.

   • Substitution variables (optional): If you selected the Cloud Buildconfig file as your build config option, you can choose to define trigger-specificsubstitution variables using this field. For example, say you're creatingmultiple 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 configfile and then use this field to define substitution variables specifying whichenvironment this trigger should deploy to. For information on specifyingsubstitution values in build config files, seeSubstituting variable values.

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

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

     Note: Only the service account specified on your trigger is used forbuilds executed by triggers. If you specified a service account in yourbuild config, it's ignored during build execution when using triggers.

5. ClickCreate to save your build trigger.

To create GitHub triggers usinggcloud commands, see thegcloudcommands forCreating a build trigger.

gcloud CLI

To create GitHub triggers usinggcloud commands, run the followingcommand:

gcloudalphabuildstriggerscreatedeveloper-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 theregion 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 yourrepository to invoke the build on.
• TAG_PATTERN is the tag name in yourrepository to invoke the build on.
• BUILD_CONFIG_FILE is the path to your buildconfiguration file.
• SERVICE-ACCOUNT is the service account to usefor trigger and build operations.

API

To create a GitHub trigger with the API, use thefollowing 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 usefor 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 theoptionalinclude_build_logs field. If this field has a value ofINCLUDE_BUILD_LOGS_SPECIFIED, then build logs are shown onyour repository.

Enter the followingcurl command in your terminal:

curl-XPOST-H"Authorization: Bearer "$(gcloudauthprint-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.