Skip to main content

GitHub GitHub

GitHub is an online software development platform used for storing, tracking, and collaborating on software projects.

Creating a GitHub connection

Select one of the following methods to create a GitHub connection:

Using OAuth

Creating your connection

  1. In the Blink platform, navigate to the Connections page > Add connection. A New Connection dialog box opens displaying icons of external service providers available.
  2. Select the GitHub icon. A dialog box with name of the connection and connection methods appear.
  3. (Optional) Edit the name of the connection. At a later stage you cannot edit the name.
  4. Click GitHub to authenticate using OAuth.
  5. Sign in using your credentials.

Using access token

Obtaining the credentials

Follow the instructions in the following link: Creating a personal access token

Creating your connection

  1. In the Blink platform, navigate to the Connections page > Add connection. A New Connection dialog box opens displaying icons of external service providers available.
  2. Select the GitHub icon. A dialog box with name of the connection and connection methods appear.
  3. (Optional) Edit the name of the connection. At a later stage you cannot edit the name.
  4. Select Access Token as the method to create the connection.
  5. Fill in the parameters:
    • The access token
    • If using on-prem GitHub installation, one also needs to fill the API Address attribute for the GitLab plugin. The default API address is https://github.com/api/v4.
  6. (Optional) Click Test Connection to test it.
  7. Click Create connection. The new connection appears on the Connections page.

Using SSH

An SSH connection is supported for the use of core.git

To create the connection you need:

  • An existing SSH private and public key pair or generate a new one. To generate a new SSH key pair can use the SSH-keygen command.

Obtaining the credentials

You need to upload the public key to GitHub. Do this by following the instructions: Adding a new SSH key to your GitLab account
We do not support SSH key with passphrase for the CLI, therefore generate one without a passphrase.

Creating your connection

  1. In the Blink platform, navigate to the Connections page > Add connection. A New Connection dialog box opens displaying icons of external service providers available.
  2. Select the SSH icon. A dialog box with name of the connection and connection methods appear.
  3. (Optional) Edit the name of the connection. At a later stage you cannot edit the name.
  4. Select SSH as the method to make the connection.
  5. Fill in the parameters:
    • The key
    • The passphrase
    • The username
  6. (Optional) Click Test Connection to test it.
  7. Click Create connection. The new connection appears on the Connections page.

Interactive Tutorial Guides

You can also refer to the following tutorial guides for a more in-depth understanding of how to create a GitHub connection.