- Home
- Cloud Build
- Documentation
- Guides
This page explains how to create manual triggers to build codein source repositories. Manual triggers can be usedto invoke builds manually, with the ability to override defined substitution variable values atinvocation time prior to running a build. You can also schedule manualtriggers to automatically run at a specific time.
To learn how to start builds manually using the gcloud CLI orthe Cloud Build API, seeStarting builds manually.
Before you begin
-
Enable the Cloud Build API.
Enable the API
- Have your source code ready.
Manual triggers
Manual triggers enable you to set up builds that are only executedwhen you invoke your trigger on connected repositories. Let's say you're creatinga pipeline for deploying your source code to a staging or production environment.You might want to automate your workflow, but are only looking to execute buildsmanually. You can define manual triggers to do so.
Manual triggers enable you to manually invoke builds by:
- Fetching source code from a hosted repository with a specified branch or tag.
- Parametizing your build with substitutions that don't need to be passed inmanually each time you execute a build.
- Overriding defined substitution variable values at invocation time prior toinvoking a build.
If you want to execute builds from your local working directory instead of a hosted repositoryor want to submit builds without creating a trigger, you can run the followinggcloud
command in your working directory:
gcloud builds submit --config BUILD_CONFIG SOURCE_CODE
Where:
- BUILD_CONFIG is the path to the build config file.
- SOURCE_CODE is the path or URL source code.
To learn more about how to use the gcloud
command to start builds manuallyin your local directory, see Starting builds manually.
Creating manual triggers
Console
To create a manual trigger:
Open the Triggers page:
Open the Triggers page
Select your project from the top of the page and click Open.
Click Create trigger.
Enter the following trigger settings:
- Name: A name for your trigger.
Region: Select the region for your trigger.
- If you select global as the region,Cloud Build uses the defaultpool to run your build.
- If you select a non-global region and thebuild config file associated with the triggerspecifies a private pool, Cloud Build uses the privatepool 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 you select a non-global region and thebuild config file associated with the triggerdoes not specify a private pool,Cloud Build uses the defaultpool to run your build in the same regionas your trigger.
Description (Optional): A description for your trigger.
Event: Select Manual invocation to set up your trigger so that buildsonly run when the trigger is manually invoked.
Source: Select the repository to build when the manual trigger runs. You can specify 1st generation or 2nd generation as your source.
Revision: Select the branch or tag to build when the manual triggerruns.
Branch: Set a trigger to build on this branch.You must specify a literal value. Regular expressions are not currentlysupported.
Tag: Set a trigger to build on this tag. You must specify a literalvalue. Regular expressions are not currently supported.
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.
- Cloud Build configuration file (yaml or json):Use a build config file for your configuration.
- Dockerfile: Use a
Dockerfile
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, the
Dockerfile
directory, or the buildpacks directory. If your build configtype is aDockerfile
or a buildpack, you will need to providea name for the resulting image and optionally, a timeout for yourbuild. When you've provided theDockerfile
or buildpackimage name, you'll see a preview of thedocker build
orpack
command that your build will execute. - Inline: If you selectedCloud 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.
- Repository: If your config file is located in yourremote repository, provide the location of yourbuild config file, the
- Type: Select the type of configuration to use for your build.
Click Create to create your manual trigger.
gcloud
For a complete list of flags, see the gcloud reference for how to create manual triggers.
Running manual triggers
Console
To run a manual trigger using Google Cloud console:
Open the Triggers page in the Google Cloud console.
Open the triggers page
Locate your trigger in the list.
Click Run trigger.
After clicking Run trigger, you will see the Run trigger window paneon the right side. If you specified fields such as a branch name, tagname, or substitution variables, you will be able to override these fieldsat invocation time.
If you specified new variable values for your substitution, click Run triggerto execute your build.
To run manual triggers on schedule, seeScheduling builds.
gcloud
To run a manual trigger using the gcloud
command-line tool, run the followingcommand:
gcloud builds triggers run TRIGGER_NAME \ --region=REGION \ --branch=BRANCH_NAME \ --substitutions=SUBSTITUTION_VAR=SUBSTITUTION_VALUE
Where:
TRIGGER_NAME
is the name of your trigger.REGION
is the region for your trigger.BRANCH_NAME
is the name of your branch. You canalso specify a tag using--tag
or a commit ID using--sha
.- [Optional]
SUBSTITUTION_VAR
is the variable name for your substitution value. - [Optional]
SUBSTITUTION_VALUE
is the value associated with your substitution variable.
To run manual triggers on schedule, see Scheduling builds.
Next steps
- Learn how to start builds manually using
gcloud
commands or the Cloud Build API. - Learn how to schedule builds.
- Learn how to create and manage triggers.
- Learn how to view build results.
- Learn how to troubleshoot build errors.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-10 UTC.
[{ "type": "thumb-down", "id": "hardToUnderstand", "label":"Hard to understand" },{ "type": "thumb-down", "id": "incorrectInformationOrSampleCode", "label":"Incorrect information or sample code" },{ "type": "thumb-down", "id": "missingTheInformationSamplesINeed", "label":"Missing the information/samples I need" },{ "type": "thumb-down", "id": "otherDown", "label":"Other" }] [{ "type": "thumb-up", "id": "easyToUnderstand", "label":"Easy to understand" },{ "type": "thumb-up", "id": "solvedMyProblem", "label":"Solved my problem" },{ "type": "thumb-up", "id": "otherUp", "label":"Other" }]