Add Github as a code provider

February 25, 2020

Before you can install your application code in the cloud, you need to set up an integration between Smoothy and your Git provider. This allows Smoothy to automatically download your code from Git, build it into an executable binary, and roll out the latest version of your application, whenever you push new code changes to your Git repository.

This tutorial walks you step-by-step through the process of setting up an integration between your Github account and Smoothy.

The tutorial assumes that:

  1. You already have a Github account

Add a Github code provider #

To integrate a new code provider, you should head over to your team's integration page. This is accessible via the button in the right upper corner of Smoothy, as shown in the screenshot below.

Team navigation

Hover the button in the upper right corner of the code providers table and click Add code provider.

Code providers

Next, a modal will appear, similar to the one in the screenshot below. In this modal, you have to select which code provider that you like to set up an integration with. Given the focus of this tutorial, this should be Github.

You also need to select who in your team will be able to use this code provider. You can choose between All team members and Only me.

When should you select which option?

  1. If your Github account contains only repositories that are accessible to all your team members, you should select the option All team members. This enables all your colleagues to browse through your Git repositories and install the contents of any repository on a server.
  2. If your Github account contains repositories that you don't want your colleagues to be able to deploy, you should select the option Only me. This way, your colleagues have no access to your Git repositories and only you can decide which Git repository to install on a server.

Finally, you can specify a name for your code provider. By default, Smoothy fills out this field for you so you can leave it untouched. However, if you have multiple Github integrations, you can assign each of them a distinctive name.

Integrate Github

In the next step of the process, you need to specify a Personal Access Token that grants Smoothy access to your Github account. To obtain such a token, you can follow along with the steps below.

Integrate Github

First, head over to Github. Hover your profile picture in the upper right corner of the interface, as shown in the screenshot below. This should open up a popup containing a link to your account's Settings page. Click this link.

Integrate Github

On the settings page of your Github account, look through the navigation on the lefthand side of the page, find the navigation item Developers settings and click it.

Integrate Github

Next, on the Developers settings page, click on the navigation item Personal access tokens in the side navigation on the left. You should now see a page similar to the one in the screenshot below.

This page gives you an overview of all the Personal Access Tokens that you have generated for your account in the past. To generate a new token, click the button labeled Generate new token at the top of the page.

Integrate Github

In the form that appears, you need to specify a name for your Personal Access Token. It is recommended to use the word Smoothy in the name so that you at a later point in time remember that this specific token was created to be used with Smoothy.

You also need to specify the rights that you want to grant to the token. Similar to the screenshot below, you need to enable the repo, admin:public_key, and admin:repo_hook options. All the other rights can remain unchecked.

cool

This grants Smoothy full control over your public and private Github repositories. This is necessary to be able to download the source code of your applications and automate your deployment processes.

Integrate Github

As soon as you click Generate token, you may need to confirm your action by providing your Github password.

Integrate Github

After that, your new Personal Access Token will appear. Copy this token to your clipboard, and head back to Smoothy.

Integrate Github

Finally, paste the Personal Access Token in the field and hit Create.

Integrate Github

Your new Github integration should now appear on your team's integrations page.

Where to go from here? #

Now that you have set up an integration between your Github account and Smoothy, you can turn the source code of your applications into an image. To do so, you can follow along with one of these tutorials.

Michiel Kempen

Michiel Kempen

A passionate cloud engineer who helps software companies adopt modern cloud technologies through an intelligent all-in-one cloud platform called Smoothy.