- NAME
-
- gcloud builds triggers create cloud-source-repositories - create a build trigger from a Cloud Source Repository
- SYNOPSIS
-
-
gcloud builds triggers create cloud-source-repositories
(--trigger-config
=PATH
| [--repo
=REPO
(--branch-pattern
=REGEX
|--tag-pattern
=REGEX
) (--build-config
=PATH
|--inline-config
=PATH
| [--dockerfile
=DOCKERFILE
:--dockerfile-dir
=DOCKERFILE_DIR
; default="/"--dockerfile-image
=DOCKERFILE_IMAGE
]) :--description
=DESCRIPTION
--ignored-files
=[GLOB
,…]--included-files
=[GLOB
,…]--name
=NAME
--region
=REGION
--[no-]require-approval
--service-account
=SERVICE_ACCOUNT
--substitutions
=[KEY
=VALUE
,…]]) [GCLOUD_WIDE_FLAG …
]
-
- DESCRIPTION
- Create a build trigger from a Cloud Source Repository.
- EXAMPLES
-
To create a push trigger for all branches:
gcloud builds triggers create cloud-source-repositories --name="my-trigger" --service-account="projects/my-project/serviceAccounts/my-byosa@my-project.iam.gserviceaccount.com" --repo="my-repo" --branch-pattern=".*" --build-config="cloudbuild.yaml"
- REQUIRED FLAGS
-
-
Exactly one of these must be specified:
--trigger-config
=PATH
- Path to Build Trigger config file (JSON or YAML format). For more details, see https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.triggers#BuildTrigger
-
Flag based trigger configuration
-
Repo resource - Cloud Source Repository. This represents a Cloud resource.
(NOTE) Some attributes are not given arguments in this group but can be set in
other ways.
To set the
project
attribute:-
provide the argument
--repo
on the command line with a fully specified name; -
set the property
core/project
.
This must be specified.
--repo
=REPO
-
ID of the repo or fully qualified identifier for the repo.
To set the
repo
attribute:-
provide the argument
--repo
on the command line.
-
provide the argument
-
provide the argument
--description
=DESCRIPTION
- Build trigger description.
--ignored-files
=[GLOB
,…]- Glob filter. Changes only affecting ignored files won't trigger builds.
--included-files
=[GLOB
,…]- Glob filter. Changes affecting at least one included file will trigger builds.
--name
=NAME
- Build trigger name.
--region
=REGION
-
The region of the Cloud Build Service to use. Must be set to a supported region
name (e.g.
us-central1
). If unset,builds/region
, which is the default region to use when working with Cloud Build resources, is used. If builds/region is unset, region is set toglobal
. Note: Region must be specified in 2nd gen repo;global
is not supported. --[no-]require-approval
-
Require manual approval for triggered builds. Use
--require-approval
to enable and--no-require-approval
to disable. --service-account
=SERVICE_ACCOUNT
-
The service account used for all user-controlled operations including
UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service
account is set, then the standard Cloud Build service account
([PROJECT_NUM]@system.gserviceaccount.com) is used instead. Format:
projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}
. --substitutions
=[KEY
=VALUE
,…]-
Parameters to be substituted in the build specification. For example:
gcloud builds triggers create cloud-source-repositories … --substitutions _FAVORITE_COLOR=blue,_NUM_CANDIES=10
This will result in a build where every occurrence of
${_FAVORITE_COLOR}
in certain fields is replaced by "blue", and similarly for${_NUM_CANDIES}
and "10".Substitutions can be applied to user-defined variables (starting with an underscore) and to the following built-in variables: REPO_NAME, BRANCH_NAME, TAG_NAME, REVISION_ID, COMMIT_SHA, SHORT_SHA.
For more details, see: https://cloud.google.com/build/docs/configuring-builds/substitute-variable-values
-
Exactly one of these must be specified:
--branch-pattern
=REGEX
-
A regular expression specifying which git branches to match.
This pattern is used as a regular expression search for any incoming pushes. For example, --branch-pattern=foo will match "foo", "foobar", and "barfoo". Events on a branch that does not match will be ignored.
The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax.
--tag-pattern
=REGEX
-
A regular expression specifying which git tags to match.
This pattern is used as a regular expression search for any incoming pushes. For example, --tag-pattern=foo will match "foo", "foobar", and "barfoo". Events on a tag that does not match will be ignored.
The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax.
-
Exactly one of these must be specified:
--build-config
=PATH
-
Path to a YAML or JSON file containing the build configuration in the
repository.
For more details, see: https://cloud.google.com/cloud-build/docs/build-config
--inline-config
=PATH
- Local path to a YAML or JSON file containing a build configuration.
-
Dockerfile build configuration flags
--dockerfile
=DOCKERFILE
-
Path of Dockerfile to use for builds in the repository.
If specified, a build config will be generated to run docker build using the specified file.
The filename is relative to the Dockerfile directory.
This flag argument must be specified if any of the other arguments in this group are specified.
--dockerfile-dir
=DOCKERFILE_DIR
; default="/"-
Location of the directory containing the Dockerfile in the repository.
The directory will also be used as the Docker build context.
--dockerfile-image
=DOCKERFILE_IMAGE
-
Docker image name to build.
If not specified, gcr.io/PROJECT/github.com/REPO_OWNER/REPO_NAME:$COMMIT_SHA will be used.
Use a build configuration (cloudbuild.yaml) file for building multiple images in a single trigger.
-
Repo resource - Cloud Source Repository. This represents a Cloud resource.
(NOTE) Some attributes are not given arguments in this group but can be set in
other ways.
-
Exactly one of these must be specified:
- GCLOUD WIDE FLAGS
-
These flags are available to all commands:
--access-token-file
,--account
,--billing-project
,--configuration
,--flags-file
,--flatten
,--format
,--help
,--impersonate-service-account
,--log-http
,--project
,--quiet
,--trace-token
,--user-output-enabled
,--verbosity
.Run
$ gcloud help
for details. - NOTES
-
These variants are also available:
gcloud alpha builds triggers create cloud-source-repositories
gcloud beta builds triggers create cloud-source-repositories
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-02-06 UTC.