How to use GitHub as a destination

Learn how Specify and GitHub work together and how you can fix potential synchronization issues.

Pierre-Antoine Lemaître avatar
Written by Pierre-Antoine Lemaître
Updated over a week ago

Introduction

The Specify GitHub app helps you distribute your design tokens and assets from your Specify to your GitHub repositories. Every changes detected in your Specify repository will create a Pull Request in your GitHub repository.

If a Pull Request has already been opened by Specify and has not been closed/merged, Specify will update it with new design data updates.

Check our video tutorial to help you get started with the GitHub integration:

⚠️ Please keep in mind you can't connect the GitHub app to several Specify organizations.

Have trouble getting automated Pull Requests?

Case 1: Your Specify config file is not updated on your main branch

Please make sure to update your .specifyrc.json configuration file on your main branch so your changes take effect.

Case 2: you've installed the Specify GitHub app but no Pull Request are created

Please make sure the owner of your GitHub organization validates the installation of the Specify GitHub app.

You should be able to see the app in your GitHub organizations GitHub app's listing (https://github.com/organizations/your_github_organization/settings/apps).

Case 3: Your Specify configuration file has errors

Please make sure to test your configuration with the Specify CLI beforehand. We advise you to test your configuration beforehand as you can't get any feedback from our API directly in GitHub.

You could also use our REST API or our CLI within a GitHub Action to get feedback from our API.

Did this answer your question?