- NAME
-
- gcloud alpha builds triggers update cloud-source-repositories - updates Cloud Source Repositories trigger used by Cloud Build
- SYNOPSIS
-
-
gcloud alpha builds triggers update cloud-source-repositories
(TRIGGER
:--region
=REGION
) (--trigger-config
=PATH
|--description
=DESCRIPTION
--ignored-files
=[GLOB
,…]--included-files
=[GLOB
,…]--repo
=REPO
--[no-]require-approval
--service-account
=SERVICE_ACCOUNT
--branch-pattern
=REGEX
|--tag-pattern
=REGEX
--build-config
=PATH
|--inline-config
=PATH
| [--dockerfile
=DOCKERFILE
--dockerfile-image
=DOCKERFILE_IMAGE
:--dockerfile-dir
=DOCKERFILE_DIR
]--clear-substitutions
|--remove-substitutions
=[KEY
,…] |--update-substitutions
=[KEY
=VALUE
,…]) [GCLOUD_WIDE_FLAG …
]
-
- DESCRIPTION
-
(ALPHA)
Updates Cloud Source Repositories trigger used by Cloud Build. - EXAMPLES
-
To update the branch pattern of the trigger:
gcloud alpha builds triggers update cloud-source-repositories my-trigger --branch-pattern=".*"
To update the build config of the trigger:
gcloud alpha builds triggers update cloud-source-repositories my-trigger --build-config="cloudbuild.yaml"
To update the substitutions of the trigger:
gcloud alpha builds triggers update cloud-source-repositories my-trigger --update-substitutions=_REPO_NAME=my-repo,_BRANCH_NAME=master
- POSITIONAL ARGUMENTS
-
-
Trigger resource - Build Trigger. The arguments in this group can be used to
specify the attributes of this 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
TRIGGER
on the command line with a fully specified name; -
provide the argument
--project
on the command line; -
set the property
core/project
.
This must be specified.
TRIGGER
-
ID of the trigger or fully qualified identifier for the trigger.
To set the
trigger
attribute:-
provide the argument
TRIGGER
on the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--region
=REGION
-
The Cloud location for the trigger.
To set the
region
attribute:-
provide the argument
TRIGGER
on the command line with a fully specified name; -
provide the argument
--region
on the command line; -
set the property
builds/region
.
-
provide the argument
-
provide the argument
-
Trigger resource - Build Trigger. The arguments in this group can be used to
specify the attributes of this resource. (NOTE) Some attributes are not given
arguments in this group but can be set in other ways.
- 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
--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.
-
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
.
--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
--[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}
. -
At most one of these can 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.
-
At most one of these can 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-image
=DOCKERFILE_IMAGE
-
Docker image name to build.
This flag argument must be specified if any of the other arguments in this group are specified.
--dockerfile-dir
=DOCKERFILE_DIR
-
Location of the directory containing the Dockerfile in the repository.
The directory will also be used as the Docker build context.
-
At most one of these can be specified:
--clear-substitutions
- Clear existing substitutions.
--remove-substitutions
=[KEY
,…]- Remove existing substitutions if present.
--update-substitutions
=[KEY
=VALUE
,…]-
Update or add to existing substitutions. Substitutions are parameters to be
substituted or add in the build specification.
For example (using some nonsensical substitution keys; all keys must begin with an underscore):
gcloud builds triggers update …
--update-substitutions _FAVORITE_COLOR=blue,_NUM_CANDIES=10This will add the provided substitutions to the existing substitutions and results in a build where every occurrence of
${_FAVORITE_COLOR}
in certain fields is replaced by "blue", and similarly for${_NUM_CANDIES}
and "10".Only the following built-in variables can be specified with the
--substitutions
flag: REPO_NAME, BRANCH_NAME, TAG_NAME, REVISION_ID, COMMIT_SHA, SHORT_SHA.For more details, see: https://cloud.google.com/build/docs/build-config-file-schema#substitutions
-
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
-
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation-only early access
allowlist. These variants are also available:
gcloud builds triggers update cloud-source-repositories
gcloud beta builds triggers update 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.