Information for: DEVELOPERS   PARTNERS   SUPPORT

Obtaining required GitHub information

Use this page if you have questions about how to find the information the optional Cloud Platform pipelines command-line client requires from GitHub during the connection configuration process. The following steps are not required to connect through the user interface.

Required GitHub permissions

To control the connection between a GitHub repository and the pipelines client, the user running the pipelines github-connect or pipelines github-disconnect command must have the proper permissions for the GitHub repository.

Git repositories can be owned by a user or an organization:

  • For repositories owned by a user account, the user must be the owner of the user account.
  • For repositories owned by an organization, the user must have the GitHub Owner role in the organization owning it.

For more information, see What are the different access permissions? in the GitHub help.

Obtaining your GitHub personal access token

To use pipelines github-connect or pipelines github-disconnect, you must supply a GitHub personal access token. To retrieve your GitHub personal access token, complete the following steps:

  1. Sign in to your GitHub account.

  2. Change the settings for your GitHub profile by clicking your profile image in the upper right, and then click Settings.

    Profile Settings option

  3. At the bottom of the left menu, in the Developer settings section, click the Personal access tokens link.

    Person access tokens link

  4. On the Personal access tokens page, click Generate new token at the top of the page.

  5. In the Token description field, enter a description or name for your new token (such as Cloud Platform).

  6. In the Select scopes section, select the repo check box.

    Personal access token settings

  7. Scroll to the bottom of the page, and then click Generate token.

    Generate token button

The Personal access tokens page displays your new token, which is a string like 91a2b3c45d6f159ce524ac411e6d63b307e5ca93. Since you can’t display the token again in the GitHub interface, copy the token and save it in a secure place.

You can then paste the token into the appropriate pipelines command.

Note

After creating the personal access token, the GitHub user no longer needs the Owner role on GitHub. Changing the user’s permission levels, once the token is created, will have no effect on the token.