Specify Docs
Specify ↗︎Changelog ↗︎Guide ↗︎
V1
V1
  • Getting started
    • Introduction
    • What is Specify?
    • Getting started
    • Glossary
  • Advanced Repository
    • Getting started
    • Figma Variables & Styles
    • Tokens Studio
    • CLI & Config
    • Querying a SDTF graph
    • GitHub
    • Parsers
      • to-css-custom-properties
      • to-style-dictionary
      • to-tailwind
      • to-sdtf
      • to-javascript
      • to-react-native
      • to-json
      • to-typescript
      • filter
      • select-modes
      • change-case
      • convert-color
      • convert-dimension
    • Templates
      • CSS Custom Properties
      • SDTF
      • Tailwind
    • REST API
    • Playground
  • Concepts
    • Token types
    • Configuration
    • Parsers
    • Templates
    • Best practices
  • Apps & Tools
    • Overview
    • GitHub
    • npm
    • GitLab
    • Bitbucket
    • Azure DevOps
    • REST API
    • CLI
    • Notion
    • Raycast
  • Useful links
    • Discord
    • YouTube
    • Twitter
    • Help Center
Powered by GitBook
On this page
  • Prerequisites
  • Installation
  • Connecting Specify and GitHub
  • Useful resources

Was this helpful?

Edit on GitHub
Export as PDF
  1. Advanced Repository

GitHub

Learn how to distribute your design tokens from Specify to your GitHub repositories via automated Pull Requests.

PreviousQuerying a SDTF graphNextParsers

Last updated 1 year ago

Was this helpful?

Specify will sync your GitHub repository if you have a config file .specifyrc.json saved at the root of your GitHub repository.

Prerequisites

Please make sure you have:

  • A GitHub account

  • A Specify account

  • One or multiple new Advanced Repositories Specify repositories containing some design tokens.

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

  1. Go to the applications catalog

  2. Select GitHub

  3. Click on "Connect"

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

  5. 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.

  1. Go to the Specify Advanced Repository you want to distribute design data from

  2. Go to its "Destinations" page

  3. Click on "Create Pipeline"

  4. Select "GitHub application"

  5. Select your GitHub account

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

  7. Create the Pull Request containing your 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 🎉

Useful resources

Name for your configuration file ()

on the Destinations page
Learn More ↗︎
How to sync design tokens in a GitHub monorepo
How to run Style Dictionary with a GitHub Action