Connecting a repository

A connection stores the repository address, the branch, the token and data folders and the access token. You can have several connections, one of them is active. They all live in the Synchronization settings window on the Git Sync tab.

The Git Sync tab: the connection list, the New Sync button, the connection status and the Active badge.

#What to prepare

• A Personal Access Token from the provider with permission to read and write repository contents: GitHub, GitLab. Without a token the plugin can only read a public GitHub repository, and Push is unavailable.
• A token folder in the repository, for example tokens. If it does not exist yet, the plugin creates the files on the first Push, but the connection check warns that the folder was not found.
• A data folder for Database if you use it. This is optional.

#Create a connection

1. Press the Sync settings gear in the plugin footer.
2. On the Git Sync tab press New Sync.
3. Fill in the form, press Test connection, press Fix if offered, then Save.

The empty New Connection form: provider, name, repository, branch.

The rest of the form: the access token, Data Path with its default and Tokens Path with a hint.

#Form fields

Paths are relative to the repository root, without leading or trailing slashes. If you accidentally paste a path with backslashes, spaces or invisible characters, the form shows exactly how it read the value.

Saving needs a name, a repository and a token. Everything else can be filled in later.

#Test the connection

The Test connection button at the bottom of the form runs several checks and shows the verdict Connection OK or Problems found with the time it took.

The Test connection report: token, paths, repository, write permission, branch, the folders found and the Diff-ID service file.

Copy report copies the whole report; the token is never included.

#The Fix button

If the branch or the folders contain a typo, a different letter case or stray characters, the check suggests corrections and shows the Fix button with their count. It replaces the branch, Tokens Path, Data Path or Code folder with the values found in the repository and fills an empty Tokens Path with the folder that looks like the token folder. For a saved connection the corrections are saved immediately and the check runs again. For a new connection they are put into the form; press Save to keep them.

#Save and activate

Press Save. If another source is active right now, the form footer shows Use Git or Set Active: it makes this connection active, and the plugin footer shows the branch name. The active connection has the Active badge in the list and the Active connection label in the form.

A connection row shows its state: Connected · just now or the time of the last check, Error when the last operation failed, and Not connected when the connection has not been checked yet.

#Edit or delete

Click a connection row to open the Edit Connection form with the same fields.

Edit Connection: provider, name, repository and branch of the active connection.

The token is masked; Data Path and Tokens Path show which folders the files are read from.

The Figma file key and the Local Storage card with the switch turned on.

The trash icon in the list deletes the connection after a confirmation. The repository files are not touched.

#Typical errors

For any other error open the Diagnostics tab and run test: see Diagnostics.

#See also

• GitHub setup
• GitLab setup
• Pull, Push and branches
• Local Storage