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.

Please make sure you must have connected your GitHub account to Specify.

How to install the GitHub app:

  1. Go to the applications catalog in the Destinations page

  2. Select GitHub

  3. Click on "Connect"

  4. Select the repositories you want Specify to have access to

  5. Your will now be able to connect your Specify and your GitHub repositories together 🎉

Specify has the following permissions:

  • Read access to your GitHub repository metadata

  • Read and write access to code, issues, and pull requests

How to connect your Specify and your GitHub repositories?

Once you've connected your GitHub account, Specify has to know what design tokens to synchronize and how.

  1. Go to the Specify repository page you want to distribute design data from

  2. Go to its "Destinations" page

  3. Click on "Add destination"

  4. Select "GitHub application"

  5. Select your GitHub account

  6. Select the GitHub repository you want to distribute design data to

  7. Create the Pull Request containing your default configuration file

  8. Merge the PR created by Specify containing your configuration file

  9. Specify will now automatically sync design data to your GitHub repository 🎉

By default, Specify only returns your design data as JSON. Our newly created Pull Request contains a .specifyrc.json file doing just that from what you have in Specify. However JSON might not be what you need for your project.

Check out our templates ↗ or our guide on how to create a configuration file ↗ to create a custom configuration that suits your needs.

Did this answer your question?