gcloud alpha builds triggers create github - create a build trigger for a GitHub repository

gcloud alpha builds triggers create github(--trigger-config=PATH    | [(--branch-pattern=REGEX |--tag-pattern=REGEX | [--pull-request-pattern=REGEX :--comment-control=COMMENT_CONTROL; default="COMMENTS_ENABLED"]) (--build-config=PATH |--inline-config=PATH | [--dockerfile=DOCKERFILE :--dockerfile-dir=DOCKERFILE_DIR; default="/"--dockerfile-image=DOCKERFILE_IMAGE]) (--repository=REPOSITORY | [--repo-name=REPO_NAME--repo-owner=REPO_OWNER :--enterprise-config=ENTERPRISE_CONFIG]) :--description=DESCRIPTION--ignored-files=[GLOB,…]--include-logs-with-status--included-files=[GLOB,…]--name=NAME--region=REGION--[no-]require-approval--service-account=SERVICE_ACCOUNT--substitutions=[KEY=VALUE,…]])[GCLOUD_WIDE_FLAG …]

gcloudalphabuildstriggerscreategithub--name="my-trigger"--service-account="projects/my-project/serviceAccounts/my-byosa@my-project.iam.gserviceaccount.com"--repo-owner="GoogleCloudPlatform"--repo-name="cloud-builders"--branch-pattern=".*"--build-config="cloudbuild.yaml"

To create a pull request trigger with a 1st-gen repository for master:

gcloudalphabuildstriggerscreategithub--name="my-trigger"--service-account="projects/my-project/serviceAccounts/my-byosa@my-project.iam.gserviceaccount.com"--repo-owner="GoogleCloudPlatform"--repo-name="cloud-builders"--pull-request-pattern="^master$"--build-config="cloudbuild.yaml"

To create a pull request trigger with a 2nd gen repository for master:

gcloudalphabuildstriggerscreategithub--name="my-trigger"--repository=projects/my-project/locations/us-central1/connections/my-conn/repositories/my-repo--pull-request-pattern="^master$"--build-config="cloudbuild.yaml"--region=us-central1

Exactly one of these must be specified:

--trigger-config=PATH

Path to Build Trigger config file (JSON or YAML format). For more details, seehttps://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.

--include-logs-with-status

Build logs will be sent back to GitHub as part of the checkrun result.

--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 regionname (e.g.us-central1). If unset,builds/region,which is the default region to use when working with Cloud Build resources, isused. 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-approvalto disable.

--service-account=SERVICE_ACCOUNT

The service account used for all user-controlled operations includingUpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no serviceaccount 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:

gcloudalphabuildstriggerscreategithub …--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", andsimilarly for${_NUM_CANDIES} and "10".

Substitutions can be applied to user-defined variables (starting with anunderscore) 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. Forexample, --branch-pattern=foo will match "foo", "foobar", and "barfoo". Eventson a branch that does not match will be ignored.

The syntax of the regular expressions accepted is the syntax accepted by RE2 anddescribed athttps://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. Forexample, --tag-pattern=foo will match "foo", "foobar", and "barfoo". Events on atag that does not match will be ignored.

The syntax of the regular expressions accepted is the syntax accepted by RE2 anddescribed athttps://github.com/google/re2/wiki/Syntax.

Pull Request settings

--pull-request-pattern=REGEX

A regular expression specifying which base git branch to match for pull requestevents.

This pattern is used as a regex search for the base branch (the branch you aretrying to merge into) for pull request updates. For example,--pull-request-pattern=foo will match "foo", "foobar", and "barfoo".

The syntax of the regular expressions accepted is the syntax accepted by RE2 anddescribed athttps://github.com/google/re2/wiki/Syntax.

This flag argument must be specified if any of the other arguments in this groupare specified.

--comment-control=COMMENT_CONTROL; default="COMMENTS_ENABLED"

Require a repository collaborator or owner to comment '/gcbrun' on a pullrequest before running the build.COMMENT_CONTROL mustbe one of:

COMMENTS_DISABLED

Do not require comments on Pull Requests before builds are triggered.

COMMENTS_ENABLED

Enforce that repository owners or collaborators must comment on Pull Requestsbefore builds are triggered.

COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY

Enforce that repository owners or collaborators must comment on externalcontributors' Pull Requests before builds are triggered.

Exactly one of these must be specified:

--build-config=PATH

Path to a YAML or JSON file containing the build configuration in therepository.

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 thespecified file.

The filename is relative to the Dockerfile directory.

This flag argument must be specified if any of the other arguments in this groupare 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_SHAwill be used.

Use a build configuration (cloudbuild.yaml) file for building multiple images ina single trigger.

Exactly one of these must be specified:

--repository=REPOSITORY

Repository resource (2nd gen) to use, in the format"projects/*/locations/*/connections/*/repositories/".

1st-gen repository settings.

--repo-name=REPO_NAME

Name of the GitHub Repository (1st gen).

This flag argument must be specified if any of the other arguments in this groupare specified.

--repo-owner=REPO_OWNER

Owner of the GitHub Repository (1st gen).

This flag argument must be specified if any of the other arguments in this groupare specified.

--enterprise-config=ENTERPRISE_CONFIG

Resource name of the GitHub Enterprise config that should be applied to thisinstallation.

For example:"projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}

Run$gcloud help for details.