gcloud beta builds connections create github-enterprise

NAME
gcloud beta builds connections create github-enterprise - create a Cloud Build Connection of type GitHub Enterprise
SYNOPSIS
gcloud beta builds connections create github-enterprise(CONNECTION :--region=REGION)--host-uri=HOST_URI[--async][--app-id=APP_ID--app-slug=APP_SLUG--private-key-secret-version=PRIVATE_KEY_SECRET_VERSION--webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION :--app-installation-id=APP_INSTALLATION_ID][--service-directory-service=SERVICE_DIRECTORY_SERVICE :--ssl-ca-file=SSL_CA_FILE][GCLOUD_WIDE_FLAG …]
DESCRIPTION
(BETA) Create a Cloud Build Connection of type GitHub Enterprise.

Connections for GitHub Enterprise can be created either by following anintallation process (that requires manual steps in a web browser) or byproviding all the properties of an already-installed application as arguments tothis command.

If the GitHub Enterprise server can only be accessed within a VPC, a ServiceDirectory service resource can be provided for connecting to it.

EXAMPLES
To create a connection by following the installation process, provide only theconnection name and the host URI. If the server can only be accessed within aVPC, provide also the Service Directory service resource:
gcloudbetabuildsconnectionscreategithub-enterprisemy-ghe-conn--project=myproj--region=us-central1--host-uri=https://my.ghe-server.net--service-directory-service=projects/myproj/namespaces/x/services/mysds

The command will print a URL to be opened in a web browser in order create andinstall a GitHub App in that server. After following the URL, you can get theconnection's installation state with Thedescribe command:

gcloudalphabuildsconnectionsdescribemy-ghe-conn--region=us-central1

If the connection's installation state is not COMPLETE yet, it will provide alink to continue the installation process. Once the connection is ininstallation state COMPLETE, repositories can be added to it (seegcloud alpha builds repositories create).

--

To create a complete connection (e.g. based on an existing installation),provide all the parameters:

gcloudbetabuildsconnectionscreategithub-enterprisemy-ghe-conn--project=myproj--region=us-central1--app-id=111--app-slug=gcb-app--service-directory-service=projects/myproj/namespaces/x/services/mysds--private-key-secret-version=projects/myproj/secrets/pk/versions/1--webhook-secret-secret-version=projects/myproj/secrets/whsecret/versions/1--app-slug=myapp--app-installation-id=1234

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

POSITIONAL ARGUMENTS
Connection resource - Connection to create. The arguments in this group can beused to specify the attributes of this resource. (NOTE) Some attributes are notgiven arguments in this group but can be set in other ways.

To set theproject attribute:

  • provide the argumentconnection on the command line with a fullyspecified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.

This must be specified.

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

To set theconnection attribute:

  • provide the argumentconnection on the command line.

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

--region=REGION
The Google Cloud region.

To set theregion attribute:

  • provide the argumentconnection on the command line with a fullyspecified name;
  • provide the argument--region on the command line;
  • set the propertybuilds/region.
REQUIRED FLAGS
--host-uri=HOST_URI
URI of the GitHub Enterprise server.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to complete.
Group of arguments for the GitHub App properties.
--app-id=APP_ID
App ID of the GitHub App in the GitHub Enterprise server.

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

--app-slug=APP_SLUG
App slug (url-friendly name) of the GitHub App. When seeing the configurationpage of the App (e.g. in https://my-ghe-server.net/settings/apps/my-app), theapp-slug is the last component of the URL path ("my-app" in that example).

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

--private-key-secret-version=PRIVATE_KEY_SECRET_VERSION
Secret containing the private key of the GitHub App.

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

--webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION
Secret containing the webhook secret string for validating webhook eventsgenerated by the GitHub App.

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

--app-installation-id=APP_INSTALLATION_ID
Installation ID of the Cloud Build GitHub App.
Group of arguments for configuring access through Service Directory.
--service-directory-service=SERVICE_DIRECTORY_SERVICE
Service Directory service resource to use for accessing the GitHub EnterpriseServer. Necessary only if the server has no public access from the internet.

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

--ssl-ca-file=SSL_CA_FILE
File containing the SSL_CA to be used.
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.

API REFERENCE
This command uses thecloudbuild/v2 API. The full documentation forthis API can be found at:https://cloud.google.com/cloud-build/docs/
NOTES
This command is currently in beta and might change without notice. Thesevariants are also available:
gcloudbuildsconnectionscreategithub-enterprise
gcloudalphabuildsconnectionscreategithub-enterprise

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-05-07 UTC.