GitHub

Get started with the GitHub source!

Obtain the Credentials

If you need to figure out how to access the necessary credentials, head here for a detailed walk through of how to find the credentials.

Enable the Source

The first thing you should do is head to the flow that you would like to add the GitHub source to.

Choose the GitHub source by clicking the corresponding Connect button.

Here, you should input your GitHub Access Token and the repositories you want to sync from GitHub. If you don't know how to get your GitHub Access Token, you can learn how to here.

Now that you have entered your credentials, click the Save & Continue button in the bottom corner of the page.

And that is it! You have now linked your GitHub source. The next step is configuring what data you want to pull from the GitHub repository you are pulling data from.

Configure Mapping

You now have added GitHub as a data source for your flow. Next, you need to configure the mapping for your GitHub data.

On the sources page, go ahead and click on the GitHub card to access the configuration panel.

On this page, go ahead and open the tab to customize your field mapping by clicking the corresponding icon for the Customize field map tab.

Once you are on the Field Map page, you can select what fields you would like to pull. In this example, I am going to be pulling objects from the Issues tab. To edit what objects you want to pull from a certain field, click the corresponding gear icon to open the editor.

On this pop-up, you can go ahead and select what objects you want to pull by moving the objects on the left in the Available column to the Chosen column on the right. I am going to select all the elements on the left by using the Select All option at the top of the list.

Now using the arrows in the middle of the pop-up, move the objects you want to pull over to the Chosen column.

Now that you have selected all the objects that you want from this field, click the confirm button in the bottom right corner.

Now you should repeat all the previous steps for all the fields you want to pull from GitHub. Once you have finished configuring the fields you want to pull you should click the Save button in the bottom corner of the page. You have now finished configuring your field mapping!

Obtain your GitHub Access Token

If you need to find your GitHub Access Token, you have come to the right place. The first thing you need to do is log in to GitHub.

Now that you are logged in to GitHub, go click on your profile in the top right corner of the page.

From the resulting drop down, select the Settings option.

This is your settings page. On the right hand side, near the bottom of the page, you should see an option to head to the Developer Settings section of your account. Go ahead and do that.

You will now be on this page. Once again, one the left hand side you have a few options. You should select the Personal access tokens tab.

Next, you should click the Generate new token button in the top right hand corner.

In the Note section write "hotglue."

For the Expiration of your token, you can put whatever you like, as long as you remember to generate a new token and put it in hotglue whenever your old token expires. For this examples sake, I will be setting mine to No expiration.

For the Scopes, make sure you enable the necessary scopes for hotglue to grab data from GitHub. If you need help figuring out what scopes you should enable, you can chat with us using our live chat feature in hotglue or shoot us an email at [email protected].

Once you have everything configured, go ahead and click the Generate token button.

You have now created your Personal access token! Make sure to copy it into a safe place as well as copy it into hotglue. Once you do that, you are all set!