GitHub
Learn how to distribute your design tokens and assets from Specify to your GitHub repositories via automated Pull Request.
By default, Specify can only syncs your GitHub repository if you have a config file .specifyrc.json
at the root of your GitHub repository. If you want to sync design tokens from several Specify repositories you need to run the Specify CLI inside a GitHub Action.
Prerequisites
Please make sure you have:
A GitHub account
A Specify account
A Specify repository containing some design tokens and/or assets
Want to connect a GitHub repository from your GitHub organization? Please make sure you have the correct access rights. Otherwise, you'll need an owner to approve your installation request.
Installation
Go to the applications catalog on the Destinations page
Select GitHub
Click on "Connect"
Select the repositories you want Specify to have access to
You will now be able to connect your Specify and your GitHub repositories together 🎉
Connecting Specify and GitHub
Once you've connected your GitHub account, Specify has to know what design tokens to synchronize and how.
Go to the Specify repository page you want to distribute design data from
Go to its "Destinations" page
Click on "Create Pipeline"
Select "GitHub application"
Select your GitHub account
Select the GitHub repository you want to distribute your design data to
Select your configuration template (Learn more)
Create the Pull Request containing your configuration file
Merge the PR created by Specify containing your configuration file
Specify will now automatically sync design data to your GitHub repository 🎉
Fixing sync issues
Have trouble getting Pull Requests in your GitHub repository? Learn more about how to fix the most common issues.
Useful resources
Last updated