.TH "GCLOUD_BUILDS_CONNECTIONS_CREATE_GITHUB" 1



.SH "NAME"
.HP
gcloud builds connections create github \- create a Cloud Build Connection of type GitHub



.SH "SYNOPSIS"
.HP
\f5gcloud builds connections create github\fR (\fICONNECTION\fR\ :\ \fB\-\-region\fR=\fIREGION\fR) [\fB\-\-async\fR] [\fB\-\-authorizer\-token\-secret\-version\fR=\fIAUTHORIZER_TOKEN_SECRET_VERSION\fR\ :\ \fB\-\-app\-installation\-id\fR=\fIAPP_INSTALLATION_ID\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Create a Cloud Build Connection of type GitHub (for github.com).

Connections for github.com can be created either by following an installation
process (that requires manual steps in a web browser) or by providing the
properties of an already\-installed application (installation ID and a user
token) as arguments to this command.



.SH "EXAMPLES"

To create a connection by following the installation process, provide only the
connection name:

.RS 2m
$ gcloud builds connections create github myconn \-\-project=myproj \e
    \-\-region=us\-central1
.RE

The command will print a URL to be opened in a web browser in order to authorize
Cloud Build (i.e. Cloud Build gets an OAuth token for the github account that
you use). After doing this authorization, you can get the connection's
installation state with the describe command:

.RS 2m
$ gcloud alpha builds connections describe myconn
.RE

The output will include a second link to install the Cloud Build GitHub App.
After doing this, the connection will be in installation state COMPLETE and
repositories can be added to it (see \f5\fIgcloud\fR\fR alpha builds
repositories create).

\-\-

To create a complete connection (e.g. based on an existing user token and
installation), provide both the authorizer secret token and the app installation
id:

.RS 2m
$ gcloud builds connections create github myconn \-\-project=myproj \e
    \-\-region=us\-central1 \e
    \-\-authorizer\-token\-secret\-version=projects/myproj/secrets/\e
mytoken/versions/1 \-\-app\-installation\-id=1234
.RE

Above command creates the connection in installation state COMPLETE, ready for
adding repositories.



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Connection resource \- Connection to create. 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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5connection\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fICONNECTION\fR

ID of the connection or fully qualified identifier for the connection.

To set the \f5connection\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5connection\fR on the command line.
.RE
.sp

This positional argument must be specified if any of the other arguments in this
group are specified.

.TP 2m
\fB\-\-region\fR=\fIREGION\fR

The Google Cloud region.

To set the \f5region\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5connection\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-region\fR on the command line;
.IP "\(bu" 2m
set the property \f5builds/region\fR.
.RE
.sp


.RE
.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.

.TP 2m

Group of arguments for configuring a complete connnection.


.RS 2m
.TP 2m
\fB\-\-authorizer\-token\-secret\-version\fR=\fIAUTHORIZER_TOKEN_SECRET_VERSION\fR

Secret containing the authorizer user's token.

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

.TP 2m
\fB\-\-app\-installation\-id\fR=\fIAPP_INSTALLATION_ID\fR

Installation ID of the Cloud Build GitHub App.


.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 "API REFERENCE"

This command uses the \fBcloudbuild/v2\fR API. The full documentation for this
API can be found at: https://cloud.google.com/cloud\-build/docs/



.SH "NOTES"

These variants are also available:

.RS 2m
$ gcloud alpha builds connections create github
.RE

.RS 2m
$ gcloud beta builds connections create github
.RE