Skip to main content

Deploying SDKs to GitHub

APIMatic allows you to directly deploy your SDKs to GitHub. Furthermore you can utilise this to persist any post generation tweaks to the generated library. We always deploy to a separate branch and give our customers the freedom to handle conflicts during branch merges.

Frequently Asked Questions

How does the GitHub deployment work?
Deploying an SDK to GitHub is quite seamless, simply provide access to your GitHub account and we can either push to a repository of your choice, or automatically create a new repository under your account.

What branch does APIMatic publish to?
The branch name follows the format CodeGen-{platform} e.g., CodeGen-JAVA. This cannot be changed.

Should I make changes on the generated branch?
As part of the deployment process, we remove the contents of the branch and replace it with the contents of the SDK. Which means changes made on the generated branch will be lost in the next deployment. Ideally you should maintain your changes on a different branch (e.g master) and then pull/merge the generated branch.

Approve GitHub Access#

The first step before you can begin directly deploying your SDKs to GitHub is to authorize APIMatic to access your account.

Step 1 - Open the Integrations page#

The integrations page can be found in the Accounts section. From the top, select the GitHub tab and then click on the button to approve access to your GitHub account.

Approve

Step 2 - Authorize application#

A new tab will open up. You may have to log into GitHub if you aren't already logged in. Click on the Authorize application button.

Authorize

If asked for your password, enter it and click on Confirm password.

Confirm

APIMatic should now be authorized to deploy SDKs to your account.

Authorized

Deploy SDKs to GitHub#

After you have authorized APIMatic to use your GitHub account, you may start deploying SDKs directly to GitHub. To do so, click on Deploy to GitHub on the SDK generation dialogue box.

Deploy

You can then choose an existing repository or create a new one. You also need to enter a commit message. Click deploy after choosing the settings.

Create

You'll be presented with a link for your repository.

Link

Repository