File: //snap/google-cloud-cli/current/help/man/man1/gcloud_beta_builds_triggers_create_bitbucketserver.1
.TH "GCLOUD_BETA_BUILDS_TRIGGERS_CREATE_BITBUCKETSERVER" 1
.SH "NAME"
.HP
gcloud beta builds triggers create bitbucketserver \- create a build trigger for a Bitbucket Server repository
.SH "SYNOPSIS"
.HP
\f5gcloud beta builds triggers create bitbucketserver\fR (\fB\-\-trigger\-config\fR=\fIPATH\fR\ |\ [\fB\-\-bitbucket\-server\-config\-resource\fR=\fIBITBUCKET_SERVER_CONFIG_RESOURCE\fR\ \fB\-\-project\-key\fR=\fIPROJECT_KEY\fR\ \fB\-\-repo\-slug\fR=\fIREPO_SLUG\fR\ (\fB\-\-branch\-pattern\fR=\fIREGEX\fR\ |\ \fB\-\-tag\-pattern\fR=\fIREGEX\fR\ |\ [\fB\-\-pull\-request\-pattern\fR=\fIREGEX\fR\ :\ \fB\-\-comment\-control\fR=\fICOMMENT_CONTROL\fR;\ default=\f5"COMMENTS_ENABLED"\fR])\ (\fB\-\-build\-config\fR=\fIPATH\fR\ |\ \fB\-\-inline\-config\fR=\fIPATH\fR\ |\ [\fB\-\-dockerfile\fR=\fIDOCKERFILE\fR\ :\ \fB\-\-dockerfile\-dir\fR=\fIDOCKERFILE_DIR\fR;\ default="/"\ \fB\-\-dockerfile\-image\fR=\fIDOCKERFILE_IMAGE\fR])\ :\ \fB\-\-description\fR=\fIDESCRIPTION\fR\ \fB\-\-ignored\-files\fR=[\fIGLOB\fR,...]\ \fB\-\-included\-files\fR=[\fIGLOB\fR,...]\ \fB\-\-name\fR=\fINAME\fR\ \fB\-\-region\fR=\fIREGION\fR\ \fB\-\-[no\-]require\-approval\fR\ \fB\-\-service\-account\fR=\fISERVICE_ACCOUNT\fR\ \fB\-\-substitutions\fR=[\fIKEY\fR=\fIVALUE\fR,...]]) [\fIGCLOUD_WIDE_FLAG\ ...\fR]
.SH "DESCRIPTION"
\fB(BETA)\fR Create a build trigger for a Bitbucket Server repository.
.SH "EXAMPLES"
To create a push trigger for all branches:
.RS 2m
$ gcloud beta builds triggers create bitbucketserver \e
\-\-name="my\-trigger" \e
\-\-service\-account="projects/my\-project/serviceAccounts/my\-byosa@\e
my\-project.iam.gserviceaccount.com" \e
\-\-project\-key="GoogleCloudPlatform" \e
\-\-repo\-slug="cloud\-builders" \e
\-\-bitbucket\-server\-config\-resource="projects/1234/locations/glob\e
al/bitbucketServerConfigs/5678" \-\-branch\-pattern=".*" \e
\-\-build\-config="cloudbuild.yaml"
.RE
To create a pull request trigger for main:
.RS 2m
$ gcloud beta builds triggers create bitbucketserver \e
\-\-name="my\-trigger" \e
\-\-service\-account="projects/my\-project/serviceAccounts/my\-byosa@\e
my\-project.iam.gserviceaccount.com" \e
\-\-project\-key="GoogleCloudPlatform" \e
\-\-repo\-slug="cloud\-builders" \e
\-\-bitbucket\-server\-config\-resource="projects/1234/locations/glob\e
al/bitbucketServerConfigs/5678" \-\-pull\-request\-pattern="^main$" \e
\-\-build\-config="cloudbuild.yaml"
.RE
.SH "REQUIRED FLAGS"
.RS 2m
.TP 2m
Exactly one of these must be specified:
.RS 2m
.TP 2m
\fB\-\-trigger\-config\fR=\fIPATH\fR
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
.TP 2m
Flag based trigger configuration
.RS 2m
.TP 2m
\fB\-\-bitbucket\-server\-config\-resource\fR=\fIBITBUCKET_SERVER_CONFIG_RESOURCE\fR
Bitbucket Server config resource name.
This flag argument must be specified if any of the other arguments in this group
are specified.
.TP 2m
\fB\-\-project\-key\fR=\fIPROJECT_KEY\fR
Bitbucket Server project key.
This flag argument must be specified if any of the other arguments in this group
are specified.
.TP 2m
\fB\-\-repo\-slug\fR=\fIREPO_SLUG\fR
Bitbucket Server repository slug.
This flag argument must be specified if any of the other arguments in this group
are specified.
.TP 2m
\fB\-\-description\fR=\fIDESCRIPTION\fR
Build trigger description.
.TP 2m
\fB\-\-ignored\-files\fR=[\fIGLOB\fR,...]
Glob filter. Changes only affecting ignored files won't trigger builds.
.TP 2m
\fB\-\-included\-files\fR=[\fIGLOB\fR,...]
Glob filter. Changes affecting at least one included file will trigger builds.
.TP 2m
\fB\-\-name\fR=\fINAME\fR
Build trigger name.
.TP 2m
\fB\-\-region\fR=\fIREGION\fR
The region of the Cloud Build Service to use. Must be set to a supported region
name (e.g. \f5us\-central1\fR). If unset, \f5builds/region\fR, which is the
default region to use when working with Cloud Build resources, is used. If
builds/region is unset, region is set to \f5global\fR. Note: Region must be
specified in 2nd gen repo; \f5global\fR is not supported.
.TP 2m
\fB\-\-[no\-]require\-approval\fR
Require manual approval for triggered builds. Use \fB\-\-require\-approval\fR to
enable and \fB\-\-no\-require\-approval\fR to disable.
.TP 2m
\fB\-\-service\-account\fR=\fISERVICE_ACCOUNT\fR
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:
\f5projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}\fR.
.TP 2m
\fB\-\-substitutions\fR=[\fIKEY\fR=\fIVALUE\fR,...]
Parameters to be substituted in the build specification. For example:
.RS 2m
$ gcloud beta builds triggers create bitbucketserver ... \e
\-\-substitutions _FAVORITE_COLOR=blue,_NUM_CANDIES=10
.RE
This will result in a build where every occurrence of \f5${_FAVORITE_COLOR}\fR
in certain fields is replaced by "blue", and similarly for \f5${_NUM_CANDIES}\fR
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
.TP 2m
Exactly one of these must be specified:
.RS 2m
.TP 2m
\fB\-\-branch\-pattern\fR=\fIREGEX\fR
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.
.TP 2m
\fB\-\-tag\-pattern\fR=\fIREGEX\fR
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.
.TP 2m
Pull Request settings
.RS 2m
.TP 2m
\fB\-\-pull\-request\-pattern\fR=\fIREGEX\fR
Regular expression specifying which base git branch to match for pull request
events.
This pattern is used as a regex search for the base branch (the branch you are
trying 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 and
described at https://github.com/google/re2/wiki/Syntax.
This flag argument must be specified if any of the other arguments in this group
are specified.
.TP 2m
\fB\-\-comment\-control\fR=\fICOMMENT_CONTROL\fR; default=\f5"COMMENTS_ENABLED"\fR
Require a repository collaborator or owner to comment '/gcbrun' on a pull
request before running the build. \fICOMMENT_CONTROL\fR must be one of:
.RS 2m
.TP 2m
\fBCOMMENTS_DISABLED\fR
Do not require comments on Pull Requests before builds are triggered.
.TP 2m
\fBCOMMENTS_ENABLED\fR
Enforce that repository owners or collaborators must comment on Pull Requests
before builds are triggered.
.TP 2m
\fBCOMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY\fR
Enforce that repository owners or collaborators must comment on external
contributors' Pull Requests before builds are triggered.
.RE
.sp
.RE
.RE
.sp
.TP 2m
Exactly one of these must be specified:
.RS 2m
.TP 2m
\fB\-\-build\-config\fR=\fIPATH\fR
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
.TP 2m
\fB\-\-inline\-config\fR=\fIPATH\fR
Local path to a YAML or JSON file containing a build configuration.
.TP 2m
Dockerfile build configuration flags
.RS 2m
.TP 2m
\fB\-\-dockerfile\fR=\fIDOCKERFILE\fR
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.
.TP 2m
\fB\-\-dockerfile\-dir\fR=\fIDOCKERFILE_DIR\fR; default="/"
Location of the directory containing the Dockerfile in the repository.
The directory will also be used as the Docker build context.
.TP 2m
\fB\-\-dockerfile\-image\fR=\fIDOCKERFILE_IMAGE\fR
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.
.RE
.RE
.RE
.RE
.RE
.sp
.SH "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 \fB$ gcloud help\fR for details.
.SH "NOTES"
This command is currently in beta and might change without notice. These
variants are also available:
.RS 2m
$ gcloud builds triggers create bitbucketserver
.RE
.RS 2m
$ gcloud alpha builds triggers create bitbucketserver
.RE