mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-11 15:39:42 +00:00
164 lines
6.1 KiB
Text
164 lines
6.1 KiB
Text
NAME
|
|
gcloud alpha builds triggers create webhook - create a build trigger with a
|
|
Webhook trigger event
|
|
|
|
SYNOPSIS
|
|
gcloud alpha builds triggers create webhook
|
|
(--trigger-config=PATH | [--secret=SECRET (--build-config=PATH
|
|
| --inline-config=PATH | --dockerfile=DOCKERFILE
|
|
--dockerfile-dir=DOCKERFILE_DIR;
|
|
default="/" --dockerfile-image=DOCKERFILE_IMAGE)
|
|
: --description=DESCRIPTION --filter=FILTER --name=NAME
|
|
--require-approval --service-account=SERVICE_ACCOUNT
|
|
--substitutions=[KEY=VALUE,...] --repo=REPO (--branch=BRANCH
|
|
| --tag=TAG)]) [GCLOUD_WIDE_FLAG ...]
|
|
|
|
DESCRIPTION
|
|
(ALPHA) Create a build trigger with a Webhook trigger event.
|
|
|
|
EXAMPLES
|
|
To create a Webhook trigger that requires secret
|
|
projects/my-project/secrets/my-secret/versions/2 and builds off branch
|
|
my-branch in a GitHub repository named my-repo:
|
|
|
|
$ gcloud alpha builds triggers create webhook \
|
|
--name=my-webhook-trigger \
|
|
--service-account="projects/my-project/serviceAccounts/my-byosa@\
|
|
my-project.iam.gserviceaccount.com" \
|
|
--secret=projects/my-project/secrets/my-secret/versions/2 \
|
|
--repo=https://www.github.com/owner/repo --branch=my-branch
|
|
|
|
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
|
|
|
|
--secret=SECRET
|
|
The full path of the secret version required to validate webhook
|
|
requests against this trigger. For example,
|
|
projects/my-project/secrets/my-secret/versions/1.
|
|
|
|
This flag must be specified if any of the other arguments in this
|
|
group are specified.
|
|
|
|
--description=DESCRIPTION
|
|
Build trigger description.
|
|
|
|
--filter=FILTER
|
|
CEL filter expression for the trigger. See
|
|
https://cloud.google.com/build/docs/filter-build-events-using-cel
|
|
for more details.
|
|
|
|
--name=NAME
|
|
Build trigger name.
|
|
|
|
--require-approval
|
|
Require manual approval for triggered builds.
|
|
|
|
--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 (using some nonsensical substitution keys; all keys
|
|
must begin with an underscore):
|
|
|
|
$ gcloud builds triggers create ... --config config.yaml
|
|
--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".
|
|
|
|
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/cloud-build/docs/api/build-requests#substitutions
|
|
|
|
Exactly one of these must be specified:
|
|
|
|
Build file configuration flags
|
|
|
|
--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
|
|
|
|
Build configuration file
|
|
|
|
--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.
|
|
|
|
--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.
|
|
|
|
Flags for repository information
|
|
|
|
--repo=REPO
|
|
URI of the repository. Currently only HTTP URIs for GitHub and
|
|
Cloud Source Repositories are supported.
|
|
|
|
This flag must be specified if any of the other arguments in this
|
|
group are specified.
|
|
|
|
Exactly one of these must be specified:
|
|
|
|
--branch=BRANCH
|
|
Branch to build.
|
|
|
|
--tag=TAG
|
|
Tag to build.
|
|
|
|
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.
|
|
|