Deploying SDKs to GitHub

This article is outdated. Please click here to see the newer version.

APIMATIC's integration with GitHub allows you to publish generated SDKs directly to the associated Github Account. The Github integration is a great way to maintain post-generated modifications. 

 

The following aspects are covered in this tutorial 

  1. Providing GitHub access (one time)
  2. Deploying an SDK to GitHub
  3. Merging to master
  4. A note on workflow for post-generated changes

 

1. Providing GitHub Access:

There are two ways to associate your account with GitHub. 

To setup the access during the generation of a SDK, simply generate the SDK as usual. Then select GitHub Deployment. This will bring a new window for OAuth approval.

 

2. Deploying a SDK to GitHub

Once APIMATIC is allowed to manage your repositories, GitHub Deployment will now navigate you to a form allowing you enter your new/existing repo as well as a commit message. 

 

 

3. Merging to master

As part of the deployment process, a new branch is created. The name of the branch is dependent on the type of SDK generated. For example: CodeGen-CS for a C# SDK.

The new repository would like similar to the figure below.

You are now ready to pull the generated branch in to master.

 

 

4. Workflow for post-generated changes

 

APIMATIC will always remove and overwrite the generated branch with the contents of the SDK. This means that changes made on this branch will be lost on the next deployment. Hence we pull the generated branch to master and make persistent changes there. 

 

 

 

 

 

 

 

 

 

Have more questions? Submit a request

Comments